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 2015/01/02 07:31:14 UTC
svn commit: r1648976 [1/2] - in
/manifoldcf/trunk/site/src/documentation/content/xdocs:
en_US/programmatic-operation.xml ja_JP/programmatic-operation.xml
zh_CN/programmatic-operation.xml
Author: kwright
Date: Fri Jan 2 06:31:14 2015
New Revision: 1648976
URL: http://svn.apache.org/r1648976
Log:
Add programmatic details of notification support.
Modified:
manifoldcf/trunk/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
manifoldcf/trunk/site/src/documentation/content/xdocs/zh_CN/programmatic-operation.xml
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=1648976&r1=1648975&r2=1648976&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 Fri Jan 2 06:31:14 2015
@@ -85,6 +85,7 @@
<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>notificationconnectors</td><td>GET</td><td>List all registered notification connectors</td><td>N/A</td><td>{"notificationconnector":[<em><list_of_notification_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authoritygroups</td><td>GET</td><td>List all authority groups</td><td>N/A</td><td>{"authoritygroup":[<em><list_of_authority_group_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authoritygroups/<em><encoded_group_name></em></td><td>GET</td><td>Get a specific authority group</td><td>N/A</td><td>{"authoritygroup":<em><authority_group_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authoritygroups/<em><encoded_group_name></em></td><td>PUT</td><td>Save or create an authority group</td><td>{"authoritygroup":<em><authority_group_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -119,6 +120,12 @@
<tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a repository connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/repositoryconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a repository 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/repositoryconnections/<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>notificationconnections</td><td>GET</td><td>List all notification connections</td><td>N/A</td><td>{"notificationconnection":[<em><list_of_notification_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>notificationconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific notification connection</td><td>N/A</td><td>{"notificationconnection":<em><notification_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>notificationconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a notification connection</td><td>{"notificationconnection":<em><notification_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>notificationconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a notification connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>status/notificationconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a notification 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/notificationconnections/<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>clearhistory/<em><encoded_repository_connection_name></em></td><td>PUT</td><td>Clear history linked with repository connection</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>jobs</td><td>GET</td><td>List all job definitions</td><td>N/A</td><td>{"job":[<em><list_of_job_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs</td><td>POST</td><td>Create a job</td><td>{"job":<em><job_object></em>}</td><td>{"job_id":<em><job_identifier></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -282,6 +289,18 @@
<p></p>
</section>
<section>
+ <title>Notification connector objects</title>
+ <p></p>
+ <p>The JSON fields a repository 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 group objects</title>
<p></p>
<p>Authority group names, when they are part of a URL, should be encoded as follows:</p>
@@ -432,6 +451,29 @@
<p></p>
</section>
<section>
+ <title>Notification connection objects</title>
+ <p></p>
+ <p>Notification 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 notification 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>
+ </table>
+ <p></p>
+ </section>
+ <section>
<title>Job objects</title>
<p></p>
<p>The JSON fields for a job are is as follows:</p>
@@ -452,6 +494,7 @@
<tr><td>"hopcount"</td><td>An array of hopcount objects, describing the link types and associated maximum hops permitted for the job</td></tr>
<tr><td>"schedule"</td><td>An array of schedule objects, describing when the job should be started and run</td></tr>
<tr><td>"pipelinestage"</td><td>An array of pipelinestage objects, describing what the transformation pipeline is</td></tr>
+ <tr><td>"notificationstage"</td><td>An array of notificationstage objects, describing what the notifications are</td></tr>
</table>
<p></p>
<p>Each pipelinestage object has the following fields:</p>
@@ -466,6 +509,16 @@
<tr><td>"stage_specification"</td><td>The specification string for the pipeline stage</td></tr>
</table>
<p></p>
+ <p>Each notificationstage object has the following fields:</p>
+ <p></p>
+ <table>
+ <tr><th>Field</th><th>Meaning</th></tr>
+ <tr><td>"stage_id"</td><td>The unique identifier for the notification stage</td></tr>
+ <tr><td>"stage_connectionname"</td><td>The connection name for the notification stage</td></tr>
+ <tr><td>"stage_description"</td><td>A description of the notification stage</td></tr>
+ <tr><td>"stage_specification"</td><td>The specification string for the notification stage</td></tr>
+ </table>
+ <p></p>
<p>Each hopcount object has the following fields:</p>
<p></p>
<table>
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=1648976&r1=1648975&r2=1648976&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 Fri Jan 2 06:31:14 2015
@@ -85,6 +85,7 @@
<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>notificationconnectors</td><td>GET</td><td>List all registered notification connectors</td><td>N/A</td><td>{"notificationconnector":[<em><list_of_notification_connector_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authoritygroups</td><td>GET</td><td>List all authority groups</td><td>N/A</td><td>{"authoritygroup":[<em><list_of_authority_group_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authoritygroups/<em><encoded_group_name></em></td><td>GET</td><td>Get a specific authority group</td><td>N/A</td><td>{"authoritygroup":<em><authority_group_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>authoritygroups/<em><encoded_group_name></em></td><td>PUT</td><td>Save or create an authority group</td><td>{"authoritygroup":<em><authority_group_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -119,6 +120,12 @@
<tr><td>repositoryconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a repository connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>status/repositoryconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a repository 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/repositoryconnections/<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>notificationconnections</td><td>GET</td><td>List all notification connections</td><td>N/A</td><td>{"notificationconnection":[<em><list_of_notification_connection_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>notificationconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Get a specific notification connection</td><td>N/A</td><td>{"notificationconnection":<em><notification_connection_object></em>} <strong>OR</strong> { } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>notificationconnections/<em><encoded_connection_name></em></td><td>PUT</td><td>Save or create a notification connection</td><td>{"notificationconnection":<em><notification_connection_object></em>}</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>notificationconnections/<em><encoded_connection_name></em></td><td>DELETE</td><td>Delete a notification connection</td><td>N/A</td><td>{ } <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
+ <tr><td>status/notificationconnections/<em><encoded_connection_name></em></td><td>GET</td><td>Check the status of a notification 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/notificationconnections/<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>clearhistory/<em><encoded_repository_connection_name></em></td><td>PUT</td><td>Clear history linked with repository connection</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>jobs</td><td>GET</td><td>List all job definitions</td><td>N/A</td><td>{"job":[<em><list_of_job_objects></em>]} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
<tr><td>jobs</td><td>POST</td><td>Create a job</td><td>{"job":<em><job_object></em>}</td><td>{"job_id":<em><job_identifier></em>} <strong>OR</strong> {"error":<em><error_text></em>}</td></tr>
@@ -282,6 +289,18 @@
<p></p>
</section>
<section>
+ <title>Notification connector objects</title>
+ <p></p>
+ <p>The JSON fields a repository 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 group objects</title>
<p></p>
<p>Authority group names, when they are part of a URL, should be encoded as follows:</p>
@@ -432,6 +451,29 @@
<p></p>
</section>
<section>
+ <title>Notification connection objects</title>
+ <p></p>
+ <p>Notification 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 notification 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>
+ </table>
+ <p></p>
+ </section>
+ <section>
<title>Job objects</title>
<p></p>
<p>The JSON fields for a job are is as follows:</p>
@@ -451,8 +493,8 @@
<tr><td>"reseed_interval"</td><td>The time between reseeding operations (if the job is "continuous"), in milliseconds, or "infinite" for infinity</td></tr>
<tr><td>"hopcount"</td><td>An array of hopcount objects, describing the link types and associated maximum hops permitted for the job</td></tr>
<tr><td>"schedule"</td><td>An array of schedule objects, describing when the job should be started and run</td></tr>
- <tr><td>"forcedparam"</td><td>An array of forcedparam objects, describing what forced parameters should be set</td></tr>
<tr><td>"pipelinestage"</td><td>An array of pipelinestage objects, describing what the transformation pipeline is</td></tr>
+ <tr><td>"notificationstage"</td><td>An array of notificationstage objects, describing what the notifications are</td></tr>
</table>
<p></p>
<p>Each pipelinestage object has the following fields:</p>
@@ -467,12 +509,14 @@
<tr><td>"stage_specification"</td><td>The specification string for the pipeline stage</td></tr>
</table>
<p></p>
- <p>Each forcedparam object has the following fields:</p>
+ <p>Each notificationstage object has the following fields:</p>
<p></p>
<table>
<tr><th>Field</th><th>Meaning</th></tr>
- <tr><td>"paramname"</td><td>The name of the parameter</td></tr>
- <tr><td>"paramvalue"</td><td>The value of the parameter</td></tr>
+ <tr><td>"stage_id"</td><td>The unique identifier for the notification stage</td></tr>
+ <tr><td>"stage_connectionname"</td><td>The connection name for the notification stage</td></tr>
+ <tr><td>"stage_description"</td><td>A description of the notification stage</td></tr>
+ <tr><td>"stage_specification"</td><td>The specification string for the notification stage</td></tr>
</table>
<p></p>
<p>Each hopcount object has the following fields:</p>