Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/ConnectorManager.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/ConnectorManager.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/ConnectorManager.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/ConnectorManager.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:07:59 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:30 EDT 2012 --> <TITLE> ConnectorManager </TITLE> @@ -104,16 +104,16 @@ java.lang.Object </PRE> <P> -Implementation of IConnectorManager. - - <br><br> - <b>connectors</b> - <table border="1" cellpadding="3" cellspacing="0"> - <tr class="TableHeadingColor"> - <th>Field</th><th>Type</th><th>Description </th> - <tr><td>description</td><td>VARCHAR(255)</td><td></td></tr> - <tr><td>classname</td><td>VARCHAR(255)</td><td>Primary Key</td></tr> - </table> +Implementation of IConnectorManager. + + <br><br> + <b>connectors</b> + <table border="1" cellpadding="3" cellspacing="0"> + <tr class="TableHeadingColor"> + <th>Field</th><th>Type</th><th>Description </th> + <tr><td>description</td><td>VARCHAR(255)</td><td></td></tr> + <tr><td>classname</td><td>VARCHAR(255)</td><td>Primary Key</td></tr> + </table> <br><br> <P> @@ -421,7 +421,7 @@ public void <B>registerConnector</B>(jav java.lang.String className) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Register a new connector. +<DD>Register a new connector. The connector's install method will also be called. <P> <DD><DL> @@ -441,7 +441,7 @@ unregisterConnector</H3> public void <B>unregisterConnector</B>(java.lang.String className) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Unregister a connector. +<DD>Unregister a connector. The connector's deinstall method will also be called. <P> <DD><DL> @@ -461,8 +461,8 @@ removeConnector</H3> public void <B>removeConnector</B>(java.lang.String className) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Remove a connector. - Use this method when the connector doesn't seem to be in the +<DD>Remove a connector. + Use this method when the connector doesn't seem to be in the classpath, so deregistration cannot occur. <P> <DD><DL> @@ -489,7 +489,7 @@ public <A HREF="../../../../../org/apach </DD> <DD><DL> -<DT><B>Returns:</B><DD>a resultset with the columns "description" and "classname". +<DT><B>Returns:</B><DD>a resultset with the columns "description" and "classname". These will be ordered by description. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-frame.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-frame.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-frame.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-frame.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:11 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:43 EDT 2012 --> <TITLE> org.apache.manifoldcf.crawler.connmgr </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-summary.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-summary.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-summary.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-summary.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:11 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:43 EDT 2012 --> <TITLE> org.apache.manifoldcf.crawler.connmgr </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-tree.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-tree.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-tree.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/connmgr/package-tree.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:11 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:43 EDT 2012 --> <TITLE> org.apache.manifoldcf.crawler.connmgr Class Hierarchy </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BlockingDocuments.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BlockingDocuments.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BlockingDocuments.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BlockingDocuments.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> BlockingDocuments </TITLE> @@ -100,9 +100,9 @@ java.lang.Object </PRE> <P> -An instance of this class keeps track of a pool of documents that the stuffer thread believes are ready to be reprioritized. - The way it works is that when the stuffer sees documents that it can't use, but which it thinks are eligible from reprioritization, - it hands them to this object. The prioritization thread then takes documents out of this queue and prioritizes them, before it +An instance of this class keeps track of a pool of documents that the stuffer thread believes are ready to be reprioritized. + The way it works is that when the stuffer sees documents that it can't use, but which it thinks are eligible from reprioritization, + it hands them to this object. The prioritization thread then takes documents out of this queue and prioritizes them, before it goes looking for other documents. This process guarantees that the stuffer is not blocked by documents that need reprioritization. <P> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BucketDescription.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BucketDescription.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BucketDescription.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/BucketDescription.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> BucketDescription </TITLE> @@ -100,9 +100,9 @@ java.lang.Object </PRE> <P> -Class which describes a specification of how to map a string to another string. - This facility is by necessity based on PostgreSQL's implementation of Posix regular expressions, - and the substring() operator they provide to extract data from a matched expression of these kinds. +Class which describes a specification of how to map a string to another string. + This facility is by necessity based on PostgreSQL's implementation of Posix regular expressions, + and the substring() operator they provide to extract data from a matched expression of these kinds. See http://www.postgresql.org/docs/7.4/static/functions-matching.html for details. <P> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/CacheKeyFactory.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/CacheKeyFactory.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/CacheKeyFactory.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/CacheKeyFactory.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> CacheKeyFactory </TITLE> @@ -102,7 +102,7 @@ java.lang.Object </PRE> <P> -This class just represents a central place where cache keys are assembled. +This class just represents a central place where cache keys are assembled. All methods are static. <P> @@ -184,7 +184,7 @@ This class just represents a central pla <TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/CacheKeyFactory.html#makeJobsKey()">makeJobsKey</A></B>()</CODE> <BR> - Construct a key which represents the general list of jobs - for queries + Construct a key which represents the general list of jobs - for queries that depend on the fixed kind of job data, not the dynamic data (e.g.</TD> </TR> <TR BGCOLOR="white" CLASS="TableRowColor"> @@ -349,7 +349,7 @@ makeJobsKey</H3> <PRE> public static java.lang.String <B>makeJobsKey</B>()</PRE> <DL> -<DD>Construct a key which represents the general list of jobs - for queries +<DD>Construct a key which represents the general list of jobs - for queries that depend on the fixed kind of job data, not the dynamic data (e.g. status) <P> <DD><DL> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ConnectorManagerFactory.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ConnectorManagerFactory.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ConnectorManagerFactory.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ConnectorManagerFactory.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> ConnectorManagerFactory </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/Connectors.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/Connectors.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/Connectors.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/Connectors.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> Connectors </TITLE> @@ -104,7 +104,7 @@ java.lang.Object </PRE> <P> -This class represents the configuration data read from the 'connectors.xml' file, which +This class represents the configuration data read from the 'connectors.xml' file, which describes all the individual connector classes and their pretty names. <P> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DepthStatistics.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DepthStatistics.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DepthStatistics.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DepthStatistics.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> DepthStatistics </TITLE> @@ -100,7 +100,7 @@ java.lang.Object </PRE> <P> -An instance of this class keeps a running average of how long it takes for every connection to process a document. +An instance of this class keeps a running average of how long it takes for every connection to process a document. This information is used to limit queuing per connection to something reasonable given the characteristics of the connection. <P> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentDescription.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> DocumentDescription </TITLE> @@ -100,8 +100,8 @@ java.lang.Object </PRE> <P> -This class describes a document to be fetched and processes, plus the job it's being fetched as part of, and - the time beyond which a failed fetch is considered to be a hard error. +This class describes a document to be fetched and processes, plus the job it's being fetched as part of, and + the time beyond which a failed fetch is considered to be a hard error. It is immutable. <P> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSetAndFlags.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSetAndFlags.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSetAndFlags.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSetAndFlags.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> DocumentSetAndFlags </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSpecification.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSpecification.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSpecification.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/DocumentSpecification.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> DocumentSpecification </TITLE> @@ -105,7 +105,7 @@ java.lang.Object </PRE> <P> -This class represents a document specification, which is a generalized hierarchy of nodes that +This class represents a document specification, which is a generalized hierarchy of nodes that can be interpreted by a repository connector in an appropriate way. <P> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/EnumeratedValues.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/EnumeratedValues.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/EnumeratedValues.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/EnumeratedValues.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> EnumeratedValues </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/FilterCriteria.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/FilterCriteria.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/FilterCriteria.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/FilterCriteria.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> FilterCriteria </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IAbortActivity.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IAbortActivity.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IAbortActivity.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IAbortActivity.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> IAbortActivity </TITLE> @@ -183,9 +183,9 @@ void <B>checkJobStillActive</B>() throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A>, <A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/ServiceInterruption.html" title="class in org.apache.manifoldcf.agents.interfaces">ServiceInterruption</A></PRE> <DL> -<DD>Check whether current job is still active. - This method is provided to allow an individual connector that needs to wait on some long-term condition to give up waiting due to the job - itself being aborted. If the connector should abort, this method will raise a properly-formed ServiceInterruption, which if thrown to the +<DD>Check whether current job is still active. + This method is provided to allow an individual connector that needs to wait on some long-term condition to give up waiting due to the job + itself being aborted. If the connector should abort, this method will raise a properly-formed ServiceInterruption, which if thrown to the caller, will signal that the current seeding activity remains incomplete and must be retried when the job is resumed. <P> <DD><DL> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ICarrydownActivity.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ICarrydownActivity.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ICarrydownActivity.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/ICarrydownActivity.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> ICarrydownActivity </TITLE> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IConnectorManager.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IConnectorManager.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IConnectorManager.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IConnectorManager.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> IConnectorManager </TITLE> @@ -99,7 +99,7 @@ Interface IConnectorManager</H2> </PRE> <P> -This interface describes a manager for the registry of connectors. +This interface describes a manager for the registry of connectors. Use this to register or remove a connector from the list of available choices. <P> @@ -270,7 +270,7 @@ void <B>registerConnector</B>(java.lang. java.lang.String className) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Register a new connector. +<DD>Register a new connector. The connector's install method will also be called. <P> <DD><DL> @@ -287,7 +287,7 @@ unregisterConnector</H3> void <B>unregisterConnector</B>(java.lang.String className) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Unregister a connector. +<DD>Unregister a connector. The connector's deinstall method will also be called. <P> <DD><DL> @@ -304,8 +304,8 @@ removeConnector</H3> void <B>removeConnector</B>(java.lang.String className) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Remove a connector. - Use this method when the connector doesn't seem to be in the +<DD>Remove a connector. + Use this method when the connector doesn't seem to be in the classpath, so deregistration cannot occur. <P> <DD><DL> @@ -326,7 +326,7 @@ getConnectors</H3> <P> <DD><DL> -<DT><B>Returns:</B><DD>a resultset with the columns "description" and "classname". +<DT><B>Returns:</B><DD>a resultset with the columns "description" and "classname". These will be ordered by description. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IDocumentIdentifierStream.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IDocumentIdentifierStream.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IDocumentIdentifierStream.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IDocumentIdentifierStream.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> IDocumentIdentifierStream </TITLE> @@ -96,12 +96,12 @@ Interface IDocumentIdentifierStream</H2> </PRE> <P> -Implement this interface to return a stream of local document identifiers. These will be the result - of an initial query, and should be unchanged by subsequent changes to the underlying data store. - - The semantics of calling this interface are much like using a stream: identifiers are pulled off - one-by-one, and the stream will be explicitly closed when no longer needed. The purpose for the - existence of this stream is also similar to other I/O streams: to avoid overusing main memory for +Implement this interface to return a stream of local document identifiers. These will be the result + of an initial query, and should be unchanged by subsequent changes to the underlying data store. + + The semantics of calling this interface are much like using a stream: identifiers are pulled off + one-by-one, and the stream will be explicitly closed when no longer needed. The purpose for the + existence of this stream is also similar to other I/O streams: to avoid overusing main memory for buffers. <P> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IEventActivity.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IEventActivity.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IEventActivity.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IEventActivity.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> IEventActivity </TITLE> @@ -105,43 +105,43 @@ Interface IEventActivity</H2> </PRE> <P> -This interface abstracts from the activities that use and govern events. - - The purpose of this model is to allow a connector to: - (a) insure that documents whose prerequisites have not been met do not get processed until those prerequisites are completed - (b) guarantee that only one thread at a time deal with sequencing of documents - - The way it works is as follows. We define the notion of an "event", which is described by a simple string (and thus can be global, - local to a connection, or local to a job, whichever is appropriate). An event is managed solely by the connector that knows about it. - Effectively it can be in either of two states: "completed", or "pending". The only time the framework ever changes an event state is when - the crawler is restarted, at which point all pending events are marked "completed". - - Documents, when they are added to the processing queue, specify the set of events on which they will block. If an event is in the "pending" state, - no documents that block on that event will be processed at that time. Of course, it is possible that a document could be handed to processing just before - an event entered the "pending" state - in which case it is the responsibility of the connector itself to avoid any problems or conflicts. This can - usually be handled by proper handling of event signalling. More on that later. - - The presumed underlying model of flow inside the connector's processing method is as follows: - (1) The connector examines the document in question, and decides whether it can be processed successfully or not, based on what it knows about sequencing - (2) If the connector determines that the document can properly be processed, it does so, and that's it. - (3) If the connector finds a sequencing-related problem, it: - (a) Begins an appropriate event sequence. - (b) If the framework indicates that this event is already in the "pending" state, then some other thread is already handling the event, and the connector - should abort processing of the current document. - (c) If the framework successfully begins the event sequence, then the connector code knows unequivocably that it is the only thread processing the event. - It should take whatever action it needs to - which might be requesting special documents, for instance. [Note well: At this time, there is no way - to guarantee that special documents added to the queue are in fact properly synchronized by this mechanism, so I recommend avoiding this practice, - and instead handling any special document sequences without involving the queue.] - (d) If the connector CANNOT successfully take the action it needs to to push the sequence along, it MUST set the event back to the "completed" state. - Otherwise, the event will remain in the "pending" state until the next time the crawler is restarted. - (e) If the current document cannot yet be processed, its processing should be aborted. - (4) When the connector determines that the event's conditions have been met, or when it determines that an event sequence is no longer viable and has been - aborted, it must set the event status to "completed". - - In summary, a connector may perform the following event-related actions: - (a) Set an event into the "pending" state - (b) Set an event into the "completed" state - (c) Add a document to the queue with a specified set of prerequisite events attached +This interface abstracts from the activities that use and govern events. + + The purpose of this model is to allow a connector to: + (a) insure that documents whose prerequisites have not been met do not get processed until those prerequisites are completed + (b) guarantee that only one thread at a time deal with sequencing of documents + + The way it works is as follows. We define the notion of an "event", which is described by a simple string (and thus can be global, + local to a connection, or local to a job, whichever is appropriate). An event is managed solely by the connector that knows about it. + Effectively it can be in either of two states: "completed", or "pending". The only time the framework ever changes an event state is when + the crawler is restarted, at which point all pending events are marked "completed". + + Documents, when they are added to the processing queue, specify the set of events on which they will block. If an event is in the "pending" state, + no documents that block on that event will be processed at that time. Of course, it is possible that a document could be handed to processing just before + an event entered the "pending" state - in which case it is the responsibility of the connector itself to avoid any problems or conflicts. This can + usually be handled by proper handling of event signalling. More on that later. + + The presumed underlying model of flow inside the connector's processing method is as follows: + (1) The connector examines the document in question, and decides whether it can be processed successfully or not, based on what it knows about sequencing + (2) If the connector determines that the document can properly be processed, it does so, and that's it. + (3) If the connector finds a sequencing-related problem, it: + (a) Begins an appropriate event sequence. + (b) If the framework indicates that this event is already in the "pending" state, then some other thread is already handling the event, and the connector + should abort processing of the current document. + (c) If the framework successfully begins the event sequence, then the connector code knows unequivocably that it is the only thread processing the event. + It should take whatever action it needs to - which might be requesting special documents, for instance. [Note well: At this time, there is no way + to guarantee that special documents added to the queue are in fact properly synchronized by this mechanism, so I recommend avoiding this practice, + and instead handling any special document sequences without involving the queue.] + (d) If the connector CANNOT successfully take the action it needs to to push the sequence along, it MUST set the event back to the "completed" state. + Otherwise, the event will remain in the "pending" state until the next time the crawler is restarted. + (e) If the current document cannot yet be processed, its processing should be aborted. + (4) When the connector determines that the event's conditions have been met, or when it determines that an event sequence is no longer viable and has been + aborted, it must set the event status to "completed". + + In summary, a connector may perform the following event-related actions: + (a) Set an event into the "pending" state + (b) Set an event into the "completed" state + (c) Add a document to the queue with a specified set of prerequisite events attached (d) Request that the current document be requeued for later processing (i.e. abort processing of a document due to sequencing reasons) <P> @@ -247,9 +247,9 @@ beginEventSequence</H3> boolean <B>beginEventSequence</B>(java.lang.String eventName) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Begin an event sequence. - This method should be called by a connector when a sequencing event should enter the "pending" state. If the event is already in that state, - this method will return false, otherwise true. The connector has the responsibility of appropriately managing sequencing given the response +<DD>Begin an event sequence. + This method should be called by a connector when a sequencing event should enter the "pending" state. If the event is already in that state, + this method will return false, otherwise true. The connector has the responsibility of appropriately managing sequencing given the response status. <P> <DD><DL> @@ -270,10 +270,10 @@ completeEventSequence</H3> void <B>completeEventSequence</B>(java.lang.String eventName) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Complete an event sequence. - This method should be called to signal that an event is no longer in the "pending" state. This can mean that the prerequisite processing is - completed, but it can also mean that prerequisite processing was aborted or cannot be completed. - Note well: This method should not be called unless the connector is CERTAIN that an event is in progress, and that the current thread has +<DD>Complete an event sequence. + This method should be called to signal that an event is no longer in the "pending" state. This can mean that the prerequisite processing is + completed, but it can also mean that prerequisite processing was aborted or cannot be completed. + Note well: This method should not be called unless the connector is CERTAIN that an event is in progress, and that the current thread has the sole right to complete it. Otherwise, race conditions can develop which would be difficult to diagnose. <P> <DD><DL> @@ -293,9 +293,9 @@ retryDocumentProcessing</H3> void <B>retryDocumentProcessing</B>(java.lang.String localIdentifier) throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE> <DL> -<DD>Abort processing a document (for sequencing reasons). - This method should be called in order to cause the specified document to be requeued for later processing. While this is similar in some respects - to the semantics of a ServiceInterruption, it is applicable to only one document at a time, and also does not specify any delay period, since it is +<DD>Abort processing a document (for sequencing reasons). + This method should be called in order to cause the specified document to be requeued for later processing. While this is similar in some respects + to the semantics of a ServiceInterruption, it is applicable to only one document at a time, and also does not specify any delay period, since it is presumed that the reason for the requeue is because of sequencing issues synchronized around an underlying event. <P> <DD><DL> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IFingerprintActivity.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IFingerprintActivity.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IFingerprintActivity.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IFingerprintActivity.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> IFingerprintActivity </TITLE> @@ -207,7 +207,7 @@ boolean <B>checkMimeTypeIndexable</B>(ja throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A>, <A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/ServiceInterruption.html" title="class in org.apache.manifoldcf.agents.interfaces">ServiceInterruption</A></PRE> <DL> -<DD>Detect if a mime type is indexable or not. This method is used by participating repository connectors to pre-filter the number of +<DD>Detect if a mime type is indexable or not. This method is used by participating repository connectors to pre-filter the number of unusable documents that will be passed to this output connector. <P> <DD><DL> @@ -265,7 +265,7 @@ boolean <B>checkURLIndexable</B>(java.la throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A>, <A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/ServiceInterruption.html" title="class in org.apache.manifoldcf.agents.interfaces">ServiceInterruption</A></PRE> <DL> -<DD>Pre-determine whether a document's URL is indexable by this connector. This method is used by participating repository connectors +<DD>Pre-determine whether a document's URL is indexable by this connector. This method is used by participating repository connectors to help filter out documents that are not worth indexing. <P> <DD><DL> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IHistoryActivity.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IHistoryActivity.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IHistoryActivity.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IHistoryActivity.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> IHistoryActivity </TITLE> @@ -197,13 +197,13 @@ void <B>recordActivity</B>(java.lang.Lon <DD>Record time-stamped information about the activity of the connector. <P> <DD><DL> -<DT><B>Parameters:</B><DD><CODE>startTime</CODE> - is either null or the time since the start of epoch in milliseconds (Jan 1, 1970). Every - activity has an associated time; the startTime field records when the activity began. A null value - indicates that the start time and the finishing time are the same.<DD><CODE>activityType</CODE> - is a string which is fully interpretable only in the context of the connector involved, which is - used to categorize what kind of activity is being recorded. For example, a web connector might record a - "fetch document" activity. Cannot be null.<DD><CODE>dataSize</CODE> - is the number of bytes of data involved in the activity, or null if not applicable.<DD><CODE>entityIdentifier</CODE> - is a (possibly long) string which identifies the object involved in the history record. - The interpretation of this field will differ from connector to connector. May be null.<DD><CODE>resultCode</CODE> - contains a terse description of the result of the activity. The description is limited in - size to 255 characters, and can be interpreted only in the context of the current connector. May be null.<DD><CODE>resultDescription</CODE> - is a (possibly long) human-readable string which adds detail, if required, to the result +<DT><B>Parameters:</B><DD><CODE>startTime</CODE> - is either null or the time since the start of epoch in milliseconds (Jan 1, 1970). Every + activity has an associated time; the startTime field records when the activity began. A null value + indicates that the start time and the finishing time are the same.<DD><CODE>activityType</CODE> - is a string which is fully interpretable only in the context of the connector involved, which is + used to categorize what kind of activity is being recorded. For example, a web connector might record a + "fetch document" activity. Cannot be null.<DD><CODE>dataSize</CODE> - is the number of bytes of data involved in the activity, or null if not applicable.<DD><CODE>entityIdentifier</CODE> - is a (possibly long) string which identifies the object involved in the history record. + The interpretation of this field will differ from connector to connector. May be null.<DD><CODE>resultCode</CODE> - contains a terse description of the result of the activity. The description is limited in + size to 255 characters, and can be interpreted only in the context of the current connector. May be null.<DD><CODE>resultDescription</CODE> - is a (possibly long) human-readable string which adds detail, if required, to the result described in the resultCode field. This field is not meant to be queried on. May be null.<DD><CODE>childIdentifiers</CODE> - is a set of child entity identifiers associated with this activity. May be null. <DT><B>Throws:</B> <DD><CODE><A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></CODE></DL> Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobDescription.html URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobDescription.html?rev=1345585&r1=1345584&r2=1345585&view=diff ============================================================================== --- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobDescription.html (original) +++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/interfaces/IJobDescription.html Sat Jun 2 21:24:51 2012 @@ -2,7 +2,7 @@ <!--NewPage--> <HTML> <HEAD> -<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:02 EDT 2012 --> +<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:56:33 EDT 2012 --> <TITLE> IJobDescription </TITLE> @@ -99,15 +99,15 @@ Interface IJobDescription</H2> </PRE> <P> -This is a paper object describing a job. - Each job in lcf has: - - an identifier; - - a description; - - a repository connection; - - one of a number of scheduling options: starting every n hours/days/weeks/months, on specific dates, or "continuous" (which basically - establishes a priority queue based on modification frequency); - - "seeds" (or starting points), which are the places that scanning begins. - Also remember that since incremental deletion must occur on a job-by-job basis, the scanning data also records the job that +This is a paper object describing a job. + Each job in lcf has: + - an identifier; + - a description; + - a repository connection; + - one of a number of scheduling options: starting every n hours/days/weeks/months, on specific dates, or "continuous" (which basically + establishes a priority queue based on modification frequency); + - "seeds" (or starting points), which are the places that scanning begins. + Also remember that since incremental deletion must occur on a job-by-job basis, the scanning data also records the job that performed the scan, so that each job can rescan previous ingested data, and delete documents that have been removed. <P> @@ -919,7 +919,7 @@ setPriority</H3> <PRE> void <B>setPriority</B>(int priority)</PRE> <DL> -<DD>Set the job priority. This is a simple integer between 1 and 10, where +<DD>Set the job priority. This is a simple integer between 1 and 10, where 1 is the highest priority. <P> <DD><DL>
