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:36:34 UTC
svn commit: r1648977 [1/2] - in /manifoldcf/branches/dev_1x: ./
site/src/documentation/content/xdocs/en_US/
site/src/documentation/content/xdocs/ja_JP/
site/src/documentation/content/xdocs/zh_CN/
Author: kwright
Date: Fri Jan 2 06:36:34 2015
New Revision: 1648977
URL: http://svn.apache.org/r1648977
Log:
Pull up API doc for CONNECTORS-1132.
Modified:
manifoldcf/branches/dev_1x/ (props changed)
manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/zh_CN/programmatic-operation.xml
Propchange: manifoldcf/branches/dev_1x/
------------------------------------------------------------------------------
--- svn:mergeinfo (original)
+++ svn:mergeinfo Fri Jan 2 06:36:34 2015
@@ -120,4 +120,4 @@
/manifoldcf/branches/CONNECTORS-981:1605049-1605773
/manifoldcf/branches/CONNECTORS-989:1611600-1612101
/manifoldcf/branches/CONNECTORS-990:1610284-1610707
-/manifoldcf/trunk:1620703,1620748,1620812,1620862,1621449,1621613,1621855,1622213,1622740,1622850,1622853-1622854,1623249,1623251,1623314,1623599,1623951,1623953-1623954,1623956,1623972,1624058,1624085,1624174,1624236,1624377,1624384,1624399,1624449,1624464,1624504,1624729-1624731,1624906,1624909-1624910,1624982,1625023,1625095,1625103,1625108,1625264,1625270,1625394,1625400,1625910,1626090,1626097,1626102,1626638-1626639,1626973,1627687,1627690,1627959,1628046,1628066,1628106,1628168,1628188,1628699,1628798,1628808,1628845,1628905,1629122,1629374-1629375,1629379,1629541,1629994,1630188,1630535,1630623,1630671,1630812,1630885,1631039,1631162,1631164,1631252,1631750,1631953,1632013,1632225,1632289,1632562,1632844,1632847,1632854,1633062-1633063,1633108,1633193,1633202,1633282,1633284,1633295,1633336,1633339,1633345,1633348,1633364,1633378,1633383,1633432,1633546,1633590,1633634,1633668,1633727,1633760,1633764,1633786,1633910,1633923,1634021,1634028,1634067,1634132,1634145,1634148,163
4155,1634188,1634202,1634264,1634373,1634530,1634688,1634850,1634857,1635103,1635116,1635421,1635438,1635478,1635481,1635484,1635490,1635809,1635939,1636146,1636167,1636180,1636207,1636215,1636232,1636334,1636519,1636570,1636684,1636940,1637011,1637310,1637350,1637364,1637373,1637378,1639259,1639593,1639600,1640018,1640101,1640199,1640204,1640208,1640314,1640319,1640749,1640772,1640805,1640888,1640925,1640941-1640942,1641222,1641328,1641557,1641559,1641629,1641633,1641724,1641754,1641911,1642163,1642255,1642318,1642531,1642650,1642658,1642673,1642716,1644197,1644399,1644538,1644920,1644931,1646317,1646397,1646403,1646408,1646640,1646947,1647574,1647585,1647608,1648686
+/manifoldcf/trunk:1620703,1620748,1620812,1620862,1621449,1621613,1621855,1622213,1622740,1622850,1622853-1622854,1623249,1623251,1623314,1623599,1623951,1623953-1623954,1623956,1623972,1624058,1624085,1624174,1624236,1624377,1624384,1624399,1624449,1624464,1624504,1624729-1624731,1624906,1624909-1624910,1624982,1625023,1625095,1625103,1625108,1625264,1625270,1625394,1625400,1625910,1626090,1626097,1626102,1626638-1626639,1626973,1627687,1627690,1627959,1628046,1628066,1628106,1628168,1628188,1628699,1628798,1628808,1628845,1628905,1629122,1629374-1629375,1629379,1629541,1629994,1630188,1630535,1630623,1630671,1630812,1630885,1631039,1631162,1631164,1631252,1631750,1631953,1632013,1632225,1632289,1632562,1632844,1632847,1632854,1633062-1633063,1633108,1633193,1633202,1633282,1633284,1633295,1633336,1633339,1633345,1633348,1633364,1633378,1633383,1633432,1633546,1633590,1633634,1633668,1633727,1633760,1633764,1633786,1633910,1633923,1634021,1634028,1634067,1634132,1634145,1634148,163
4155,1634188,1634202,1634264,1634373,1634530,1634688,1634850,1634857,1635103,1635116,1635421,1635438,1635478,1635481,1635484,1635490,1635809,1635939,1636146,1636167,1636180,1636207,1636215,1636232,1636334,1636519,1636570,1636684,1636940,1637011,1637310,1637350,1637364,1637373,1637378,1639259,1639593,1639600,1640018,1640101,1640199,1640204,1640208,1640314,1640319,1640749,1640772,1640805,1640888,1640925,1640941-1640942,1641222,1641328,1641557,1641559,1641629,1641633,1641724,1641754,1641911,1642163,1642255,1642318,1642531,1642650,1642658,1642673,1642716,1644197,1644399,1644538,1644920,1644931,1646317,1646397,1646403,1646408,1646640,1646947,1647574,1647585,1647608,1648686,1648976
Modified: manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml?rev=1648977&r1=1648976&r2=1648977&view=diff
==============================================================================
--- manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml (original)
+++ manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/en_US/programmatic-operation.xml Fri Jan 2 06:36:34 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>
@@ -453,6 +495,7 @@
<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,6 +510,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 forcedparam object has the following fields:</p>
<p></p>
<table>
Modified: manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml
URL: http://svn.apache.org/viewvc/manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml?rev=1648977&r1=1648976&r2=1648977&view=diff
==============================================================================
--- manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml (original)
+++ manifoldcf/branches/dev_1x/site/src/documentation/content/xdocs/ja_JP/programmatic-operation.xml Fri Jan 2 06:36:34 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>
@@ -453,6 +495,7 @@
<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,6 +510,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 forcedparam object has the following fields:</p>
<p></p>
<table>