You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@manifoldcf.apache.org by kw...@apache.org on 2013/07/01 16:54:46 UTC
svn commit: r1498493 - in /manifoldcf/trunk: CHANGES.txt
site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
Author: kwright
Date: Mon Jul 1 14:54:45 2013
New Revision: 1498493
URL: http://svn.apache.org/r1498493
Log:
Finish documentation for CONNECTORS-743.
Modified:
manifoldcf/trunk/CHANGES.txt
manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
Modified: manifoldcf/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/CHANGES.txt?rev=1498493&r1=1498492&r2=1498493&view=diff
==============================================================================
--- manifoldcf/trunk/CHANGES.txt (original)
+++ manifoldcf/trunk/CHANGES.txt Mon Jul 1 14:54:45 2013
@@ -3,6 +3,9 @@ $Id$
======================= 1.3-dev =====================
+CONNECTORS-743: Document user mapping functionality.
+(Karl Wright)
+
CONNECTORS-703: Add mapper plugin functionality, and regular expression
mapper. WARNING: This change represents a schema change!!
(Maciej Lizewski, Karl Wright)
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml?rev=1498493&r1=1498492&r2=1498493&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml Mon Jul 1 14:54:45 2013
@@ -80,6 +80,7 @@
<table>
<tr><th>Resource</th><th>Verb</th><th>What it does</th><th>Input format/query args</th><th>Output format</th></tr>
<tr><td>outputconnectors</td><td>GET</td><td>List all registered output connectors</td><td>N/A</td><td>{"outputconnector":[<em><list_of_output_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnectors</td><td>GET</td><td>List all registered mapping connectors</td><td>N/A</td><td>{"mappingconnector":[<em><list_of_mapping_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnectors</td><td>GET</td><td>List all registered authority connectors</td><td>N/A</td><td>{"authorityconnector":[<em><list_of_authority_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnectors</td><td>GET</td><td>List all registered repository connectors</td><td>N/A</td><td>{"repositoryconnector":[<em><list_of_repository_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections</td><td>GET</td><td>List all output connections</td><td>N/A</td><td>{"outputconnection":[<em><list_of_output_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -89,6 +90,11 @@
<tr><td>status/outputconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of an output connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>info/outputconnections/<em><encoded_connection_name></em>/<em><connector_specific_resource></em></td><td>GET</td><td>Retrieve arbitrary connector-specific resource</td><td>N/A</td><td><em><response_data></em> <strong>OR</strong> {"error":<em><error_text></em>} <strong>OR</strong> {"service_interruption":<em><error_text></em>}</td></tr>
<tr><td>reset/outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Forget previous indexing state</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections</td><td>GET</td><td>List all mapping connections</td><td>N/A</td><td>{"mappingconnection":[<em><list_of_mapping_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific mapping connection</td><td>N/A</td><td>{"mappingconnection":<em><mapping_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a mapping connection</td><td>{"mappingconnection":<em><mapping_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a mapping connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>status/mappingconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a mapping connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections</td><td>GET</td><td>List all authority connections</td><td>N/A</td><td>{"authorityconnection":[<em><list_of_authority_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific authority connection</td><td>N/A</td><td>{"authorityconnection":<em><authority_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an authority connection</td><td>{"authorityconnection":<em><authority_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -200,6 +206,18 @@
<p></p>
</section>
<section>
+ <title>Mapping connector objects</title>
+ <p></p>
+ <p>The JSON fields a mapping connector object has are as follows:</p>
+ <p></p>
+ <table>
+ <tr><th>Field</th><th>Meaning</th></tr>
+ <tr><td>"description"</td><td>The optional description of the connector</td></tr>
+ <tr><td>"class_name"</td><td>The class name of the class implementing the connector</td></tr>
+ </table>
+ <p></p>
+ </section>
+ <section>
<title>Authority connector objects</title>
<p></p>
<p>The JSON fields an authority connector object has are as follows:</p>
@@ -247,6 +265,30 @@
<p></p>
</section>
<section>
+ <title>Mapping connection objects</title>
+ <p></p>
+ <p>Mapping connection names, when they are part of a URL, should be encoded as follows:</p>
+ <p></p>
+ <ol>
+ <li>All instances of '.' should be replaced by '..'.</li>
+ <li>All instances of '/' should be replaced by '.+'.</li>
+ <li>The URL should be encoded using standard URL utf-8-based %-encoding.</li>
+ </ol>
+ <p></p>
+ <p>The JSON fields for a mapping connection object are as follows:</p>
+ <p></p>
+ <table>
+ <tr><th>Field</th><th>Meaning</th></tr>
+ <tr><td>"name"</td><td>The unique name of the connection</td></tr>
+ <tr><td>"description"</td><td>The description of the connection</td></tr>
+ <tr><td>"class_name"</td><td>The java class name of the class implementing the connection</td></tr>
+ <tr><td>"max_connections"</td><td>The total number of outstanding connections allowed to exist at a time</td></tr>
+ <tr><td>"configuration"</td><td>The configuration object for the connection, which is specific to the connection class</td></tr>
+ <tr><td>"prerequisite"</td><td>The mapping connection prerequisite, if any</td></tr>
+ </table>
+ <p></p>
+ </section>
+ <section>
<title>Authority connection objects</title>
<p></p>
<p>Authority connection names, when they are part of a URL, should be encoded as follows:</p>
@@ -266,6 +308,7 @@
<tr><td>"class_name"</td><td>The java class name of the class implementing the connection</td></tr>
<tr><td>"max_connections"</td><td>The total number of outstanding connections allowed to exist at a time</td></tr>
<tr><td>"configuration"</td><td>The configuration object for the connection, which is specific to the connection class</td></tr>
+ <tr><td>"prerequisite"</td><td>The mapping connection prerequisite, if any</td></tr>
</table>
<p></p>
</section>
@@ -408,6 +451,8 @@
<tr><td>org.apache.manifoldcf.authorities.CheckAll</td><td>Check all authorities to be sure they are functioning</td></tr>
<tr><td>org.apache.manifoldcf.authorities.DefineAuthorityConnection</td><td>Create a new authority connection</td></tr>
<tr><td>org.apache.manifoldcf.authorities.DeleteAuthorityConnection</td><td>Delete an existing authority connection</td></tr>
+ <tr><td>org.apache.manifoldcf.authorities.DefineMappingConnection</td><td>Create a new mapping connection</td></tr>
+ <tr><td>org.apache.manifoldcf.authorities.DeleteMappingConnection</td><td>Delete an existing mapping connection</td></tr>
<tr><td>org.apache.manifoldcf.crawler.AbortJob</td><td>Abort a running job</td></tr>
<tr><td>org.apache.manifoldcf.crawler.AddScheduledTime</td><td>Add a schedule record to a job</td></tr>
<tr><td>org.apache.manifoldcf.crawler.ChangeJobDocSpec</td><td>Modify a job's specification information</td></tr>
Modified: manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml?rev=1498493&r1=1498492&r2=1498493&view=diff
==============================================================================
--- manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml (original)
+++ manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml Mon Jul 1 14:54:45 2013
@@ -80,6 +80,7 @@
<table>
<tr><th>Resource</th><th>Verb</th><th>What it does</th><th>Input format/query args</th><th>Output format</th></tr>
<tr><td>outputconnectors</td><td>GET</td><td>List all registered output connectors</td><td>N/A</td><td>{"outputconnector":[<em><list_of_output_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnectors</td><td>GET</td><td>List all registered mapping connectors</td><td>N/A</td><td>{"mappingconnector":[<em><list_of_mapping_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnectors</td><td>GET</td><td>List all registered authority connectors</td><td>N/A</td><td>{"authorityconnector":[<em><list_of_authority_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>repositoryconnectors</td><td>GET</td><td>List all registered repository connectors</td><td>N/A</td><td>{"repositoryconnector":[<em><list_of_repository_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>outputconnections</td><td>GET</td><td>List all output connections</td><td>N/A</td><td>{"outputconnection":[<em><list_of_output_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -89,6 +90,11 @@
<tr><td>status/outputconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of an output connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>info/outputconnections/<em><encoded_connection_name></em>/<em><connector_specific_resource></em></td><td>GET</td><td>Retrieve arbitrary connector-specific resource</td><td>N/A</td><td><em><response_data></em> <strong>OR</strong> {"error":<em><error_text></em>} <strong>OR</strong> {"service_interruption":<em><error_text></em>}</td></tr>
<tr><td>reset/outputconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Forget previous indexing state</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections</td><td>GET</td><td>List all mapping connections</td><td>N/A</td><td>{"mappingconnection":[<em><list_of_mapping_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific mapping connection</td><td>N/A</td><td>{"mappingconnection":<em><mapping_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a mapping connection</td><td>{"mappingconnection":<em><mapping_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>mappingconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a mapping connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>status/mappingconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a mapping connection</td><td>N/A</td><td>{"check_result":<em><message></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections</td><td>GET</td><td>List all authority connections</td><td>N/A</td><td>{"authorityconnection":[<em><list_of_authority_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific authority connection</td><td>N/A</td><td>{"authorityconnection":<em><authority_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authorityconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create an authority connection</td><td>{"authorityconnection":<em><authority_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -200,6 +206,18 @@
<p></p>
</section>
<section>
+ <title>Mapping connector objects</title>
+ <p></p>
+ <p>The JSON fields a mapping connector object has are as follows:</p>
+ <p></p>
+ <table>
+ <tr><th>Field</th><th>Meaning</th></tr>
+ <tr><td>"description"</td><td>The optional description of the connector</td></tr>
+ <tr><td>"class_name"</td><td>The class name of the class implementing the connector</td></tr>
+ </table>
+ <p></p>
+ </section>
+ <section>
<title>Authority connector objects</title>
<p></p>
<p>The JSON fields an authority connector object has are as follows:</p>
@@ -247,6 +265,30 @@
<p></p>
</section>
<section>
+ <title>Mapping connection objects</title>
+ <p></p>
+ <p>Mapping connection names, when they are part of a URL, should be encoded as follows:</p>
+ <p></p>
+ <ol>
+ <li>All instances of '.' should be replaced by '..'.</li>
+ <li>All instances of '/' should be replaced by '.+'.</li>
+ <li>The URL should be encoded using standard URL utf-8-based %-encoding.</li>
+ </ol>
+ <p></p>
+ <p>The JSON fields for a mapping connection object are as follows:</p>
+ <p></p>
+ <table>
+ <tr><th>Field</th><th>Meaning</th></tr>
+ <tr><td>"name"</td><td>The unique name of the connection</td></tr>
+ <tr><td>"description"</td><td>The description of the connection</td></tr>
+ <tr><td>"class_name"</td><td>The java class name of the class implementing the connection</td></tr>
+ <tr><td>"max_connections"</td><td>The total number of outstanding connections allowed to exist at a time</td></tr>
+ <tr><td>"configuration"</td><td>The configuration object for the connection, which is specific to the connection class</td></tr>
+ <tr><td>"prerequisite"</td><td>The mapping connection prerequisite, if any</td></tr>
+ </table>
+ <p></p>
+ </section>
+ <section>
<title>Authority connection objects</title>
<p></p>
<p>Authority connection names, when they are part of a URL, should be encoded as follows:</p>
@@ -266,6 +308,7 @@
<tr><td>"class_name"</td><td>The java class name of the class implementing the connection</td></tr>
<tr><td>"max_connections"</td><td>The total number of outstanding connections allowed to exist at a time</td></tr>
<tr><td>"configuration"</td><td>The configuration object for the connection, which is specific to the connection class</td></tr>
+ <tr><td>"prerequisite"</td><td>The mapping connection prerequisite, if any</td></tr>
</table>
<p></p>
</section>
@@ -408,6 +451,8 @@
<tr><td>org.apache.manifoldcf.authorities.CheckAll</td><td>Check all authorities to be sure they are functioning</td></tr>
<tr><td>org.apache.manifoldcf.authorities.DefineAuthorityConnection</td><td>Create a new authority connection</td></tr>
<tr><td>org.apache.manifoldcf.authorities.DeleteAuthorityConnection</td><td>Delete an existing authority connection</td></tr>
+ <tr><td>org.apache.manifoldcf.authorities.DefineMappingConnection</td><td>Create a new mapping connection</td></tr>
+ <tr><td>org.apache.manifoldcf.authorities.DeleteMappingConnection</td><td>Delete an existing mapping connection</td></tr>
<tr><td>org.apache.manifoldcf.crawler.AbortJob</td><td>Abort a running job</td></tr>
<tr><td>org.apache.manifoldcf.crawler.AddScheduledTime</td><td>Add a schedule record to a job</td></tr>
<tr><td>org.apache.manifoldcf.crawler.ChangeJobDocSpec</td><td>Modify a job's specification information</td></tr>