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 2012/06/02 22:37:11 UTC
svn commit: r1345569 [24/36] - in /incubator/lcf/site/publish: ./
release/trunk/ release/trunk/api/activedirectory/
release/trunk/api/activedirectory/org/apache/manifoldcf/authorities/authorities/activedirectory/
release/trunk/api/alfresco/ release/tru...
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupQueue.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupQueue.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupQueue.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupQueue.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:06 EDT 2012 -->
<TITLE>
DocumentCleanupQueue
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,9 +100,9 @@ java.lang.Object
</PRE>
<P>
-This class describes a cleanup document queue, which has a "stuffer" thread and many "reader" threads.
- The queue manages thread synchronization so that (a) the "stuffer" thread blocks until queue is empty, and
- (b) the "reader" threads block if queue is empty.
+This class describes a cleanup document queue, which has a "stuffer" thread and many "reader" threads.
+ The queue manages thread synchronization so that (a) the "stuffer" thread blocks until queue is empty, and
+ (b) the "reader" threads block if queue is empty.
The objects being queued are all QueuedDocumentSet objects.
<P>
@@ -190,7 +190,7 @@ This class describes a cleanup document
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/system/DocumentCleanupQueue.html#getDocuments()">getDocuments</A></B>()</CODE>
<BR>
- Pull a document set off the queue, and wait if there is
+ Pull a document set off the queue, and wait if there is
nothing there.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -316,7 +316,7 @@ addDocuments</H3>
<PRE>
public void <B>addDocuments</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/system/DocumentCleanupSet.html" title="class in org.apache.manifoldcf.crawler.system">DocumentCleanupSet</A> dd)</PRE>
<DL>
-<DD>Add a document set to the queue. This will be a set of n documents (where n is some chunk size
+<DD>Add a document set to the queue. This will be a set of n documents (where n is some chunk size
set by experiment).
<P>
<DD><DL>
@@ -331,7 +331,7 @@ getDocuments</H3>
public <A HREF="../../../../../org/apache/manifoldcf/crawler/system/DocumentCleanupSet.html" title="class in org.apache.manifoldcf.crawler.system">DocumentCleanupSet</A> <B>getDocuments</B>()
throws java.lang.InterruptedException</PRE>
<DL>
-<DD>Pull a document set off the queue, and wait if there is
+<DD>Pull a document set off the queue, and wait if there is
nothing there.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupSet.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupSet.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupSet.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupSet.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentCleanupSet
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,7 +100,7 @@ java.lang.Object
</PRE>
<P>
-This class is what's actually queued for cleanup threads. It represents an array of DocumentDescription objects,
+This class is what's actually queued for cleanup threads. It represents an array of DocumentDescription objects,
of an appropriate size to be a decent chunk. It will be processed by a single cleanup worker thread, in bulk.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupStufferThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupStufferThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupStufferThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupStufferThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentCleanupStufferThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,10 +104,10 @@ java.lang.Object
</PRE>
<P>
-This class looks for documents that need to be deleted (as part of an end-of-job cleanup), and
- queues them up for the various document cleanup threads to take care of.
- To do this, this thread performs a query which returns a chunk of results, then queues those
- results. The individual document delete threads will be waiting on the queue.
+This class looks for documents that need to be deleted (as part of an end-of-job cleanup), and
+ queues them up for the various document cleanup threads to take care of.
+ To do this, this thread performs a query which returns a chunk of results, then queues those
+ results. The individual document delete threads will be waiting on the queue.
Once the queue is full enough, the thread then sleeps until the delete queue is empty again.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupThread.OutputRemoveActivity.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupThread.OutputRemoveActivity.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupThread.OutputRemoveActivity.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupThread.OutputRemoveActivity.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentCleanupThread.OutputRemoveActivity
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -295,13 +295,13 @@ public void <B>recordActivity</B>(java.l
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html#recordActivity(java.lang.Long, java.lang.String, java.lang.Long, java.lang.String, java.lang.String, java.lang.String)">recordActivity</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html" title="interface in org.apache.manifoldcf.agents.interfaces">IOutputHistoryActivity</A></CODE></DL>
</DD>
<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>entityURI</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>entityURI</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.
<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/system/DocumentCleanupThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentCleanupThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentCleanupThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,18 +104,18 @@ java.lang.Object
</PRE>
<P>
-This class represents a document cleanup thread. This thread's job is to pull document sets to be cleaned up off of
- a queue, and kill them. It finishes a cleanup set by getting rid of the corresponding rows in the job queue, and from
- carrydown, and from hopcount.
-
- There are very few decisions that this thread needs to make; essentially all the hard thought went into deciding
- what documents to queue in the first place.
-
- The only caveat is that the ingestion API may not be accepting delete requests at the time that this thread wants it
- to be able to accept them. In that case, it's acceptable for the thread to block until the ingestion service is
- functioning again.
-
- Transactions are not much needed for this class; it simply needs to not fail to remove the appropriate jobqueue
+This class represents a document cleanup thread. This thread's job is to pull document sets to be cleaned up off of
+ a queue, and kill them. It finishes a cleanup set by getting rid of the corresponding rows in the job queue, and from
+ carrydown, and from hopcount.
+
+ There are very few decisions that this thread needs to make; essentially all the hard thought went into deciding
+ what documents to queue in the first place.
+
+ The only caveat is that the ingestion API may not be accepting delete requests at the time that this thread wants it
+ to be able to accept them. In that case, it's acceptable for the thread to block until the ingestion service is
+ functioning again.
+
+ Transactions are not much needed for this class; it simply needs to not fail to remove the appropriate jobqueue
table rows at the end of the delete.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteQueue.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteQueue.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteQueue.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteQueue.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentDeleteQueue
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,9 +100,9 @@ java.lang.Object
</PRE>
<P>
-This class describes a document queue, which has a "stuffer" thread and many "reader" threads.
- The queue manages thread synchronization so that (a) the "stuffer" thread blocks until queue is empty, and
- (b) the "reader" threads block if queue is empty.
+This class describes a document queue, which has a "stuffer" thread and many "reader" threads.
+ The queue manages thread synchronization so that (a) the "stuffer" thread blocks until queue is empty, and
+ (b) the "reader" threads block if queue is empty.
The objects being queued are all QueuedDocumentSet objects.
<P>
@@ -190,7 +190,7 @@ This class describes a document queue, w
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/system/DocumentDeleteQueue.html#getDocuments()">getDocuments</A></B>()</CODE>
<BR>
- Pull a document set off the queue, and wait if there is
+ Pull a document set off the queue, and wait if there is
nothing there.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -316,7 +316,7 @@ addDocuments</H3>
<PRE>
public void <B>addDocuments</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/system/DocumentDeleteSet.html" title="class in org.apache.manifoldcf.crawler.system">DocumentDeleteSet</A> dd)</PRE>
<DL>
-<DD>Add a document set to the queue. This will be a set of n documents (where n is some chunk size
+<DD>Add a document set to the queue. This will be a set of n documents (where n is some chunk size
set by experiment).
<P>
<DD><DL>
@@ -331,7 +331,7 @@ getDocuments</H3>
public <A HREF="../../../../../org/apache/manifoldcf/crawler/system/DocumentDeleteSet.html" title="class in org.apache.manifoldcf.crawler.system">DocumentDeleteSet</A> <B>getDocuments</B>()
throws java.lang.InterruptedException</PRE>
<DL>
-<DD>Pull a document set off the queue, and wait if there is
+<DD>Pull a document set off the queue, and wait if there is
nothing there.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteSet.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteSet.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteSet.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteSet.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentDeleteSet
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,7 +100,7 @@ java.lang.Object
</PRE>
<P>
-This class is what's actually queued for delete threads. It represents an array of DocumentDescription objects,
+This class is what's actually queued for delete threads. It represents an array of DocumentDescription objects,
of an appropriate size to be a decent chunk. It will be processed by a single delete worker thread, in bulk.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteStufferThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteStufferThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteStufferThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteStufferThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentDeleteStufferThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,10 +104,10 @@ java.lang.Object
</PRE>
<P>
-This class looks for documents that need to be deleted (as part of a job deletion), and
- queues them up for the various document delete threads to take care of.
- To do this, this thread performs a query which returns a chunk of results, then queues those
- results. The individual document delete threads will be waiting on the queue.
+This class looks for documents that need to be deleted (as part of a job deletion), and
+ queues them up for the various document delete threads to take care of.
+ To do this, this thread performs a query which returns a chunk of results, then queues those
+ results. The individual document delete threads will be waiting on the queue.
Once the queue is full enough, the thread then sleeps until the delete queue is empty again.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteThread.OutputRemoveActivity.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteThread.OutputRemoveActivity.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteThread.OutputRemoveActivity.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteThread.OutputRemoveActivity.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentDeleteThread.OutputRemoveActivity
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -295,13 +295,13 @@ public void <B>recordActivity</B>(java.l
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html#recordActivity(java.lang.Long, java.lang.String, java.lang.Long, java.lang.String, java.lang.String, java.lang.String)">recordActivity</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html" title="interface in org.apache.manifoldcf.agents.interfaces">IOutputHistoryActivity</A></CODE></DL>
</DD>
<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>entityURI</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>entityURI</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.
<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/system/DocumentDeleteThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentDeleteThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentDeleteThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,17 +104,17 @@ java.lang.Object
</PRE>
<P>
-This class represents a document delete thread. This thread's job is to pull document sets to be deleted off of
- a queue, and kill them. It finishes a delete set by getting rid of the corresponding rows in the job queue.
-
- There are very few decisions that this thread needs to make; essentially all the hard thought went into deciding
- what documents to queue in the first place.
-
- The only caveat is that the ingestion API may not be accepting delete requests at the time that this thread wants it
- to be able to accept them. In that case, it's acceptable for the thread to block until the ingestion service is
- functioning again.
-
- Transactions are not much needed for this class; it simply needs to not fail to remove the appropriate jobqueue
+This class represents a document delete thread. This thread's job is to pull document sets to be deleted off of
+ a queue, and kill them. It finishes a delete set by getting rid of the corresponding rows in the job queue.
+
+ There are very few decisions that this thread needs to make; essentially all the hard thought went into deciding
+ what documents to queue in the first place.
+
+ The only caveat is that the ingestion API may not be accepting delete requests at the time that this thread wants it
+ to be able to accept them. In that case, it's acceptable for the thread to block until the ingestion service is
+ functioning again.
+
+ Transactions are not much needed for this class; it simply needs to not fail to remove the appropriate jobqueue
table rows at the end of the delete.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentQueue.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentQueue.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentQueue.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/DocumentQueue.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
DocumentQueue
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,9 +100,9 @@ java.lang.Object
</PRE>
<P>
-This class describes a document queue, which has a "stuffer" thread and many "reader" threads.
- The queue manages thread synchronization so that (a) the "stuffer" thread blocks until queue is empty, and
- (b) the "reader" threads block if queue is empty.
+This class describes a document queue, which has a "stuffer" thread and many "reader" threads.
+ The queue manages thread synchronization so that (a) the "stuffer" thread blocks until queue is empty, and
+ (b) the "reader" threads block if queue is empty.
The objects being queued are all QueuedDocumentSet objects.
<P>
@@ -198,7 +198,7 @@ This class describes a document queue, w
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/system/DocumentQueue.html#getDocument(org.apache.manifoldcf.crawler.interfaces.QueueTracker)">getDocument</A></B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/QueueTracker.html" title="class in org.apache.manifoldcf.crawler.interfaces">QueueTracker</A> overlapCalculator)</CODE>
<BR>
- Pull the best-rated document set off the queue, but wait if there is
+ Pull the best-rated document set off the queue, but wait if there is
nothing there.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -348,11 +348,11 @@ getDocument</H3>
public <A HREF="../../../../../org/apache/manifoldcf/crawler/system/QueuedDocumentSet.html" title="class in org.apache.manifoldcf.crawler.system">QueuedDocumentSet</A> <B>getDocument</B>(<A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/QueueTracker.html" title="class in org.apache.manifoldcf.crawler.interfaces">QueueTracker</A> overlapCalculator)
throws java.lang.InterruptedException</PRE>
<DL>
-<DD>Pull the best-rated document set off the queue, but wait if there is
+<DD>Pull the best-rated document set off the queue, but wait if there is
nothing there.
<P>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>overlapCalculator</CODE> - performs analysis of the document sets on the queue so that we can
+<DT><B>Parameters:</B><DD><CODE>overlapCalculator</CODE> - performs analysis of the document sets on the queue so that we can
pick the best one.
<DT><B>Returns:</B><DD>the document set.
<DT><B>Throws:</B>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireStufferThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireStufferThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireStufferThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireStufferThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
ExpireStufferThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,7 +104,7 @@ java.lang.Object
</PRE>
<P>
-This class represents the stuffer thread. This thread's job is to request documents from the database and add them to the
+This class represents the stuffer thread. This thread's job is to request documents from the database and add them to the
document queue. The thread then sleeps until the document queue is empty again.
<P>
@@ -310,7 +310,7 @@ public <B>ExpireStufferThread</B>(<A HRE
<DD>Constructor.
<P>
<DL>
-<DT><B>Parameters:</B><DD><CODE>documentQueue</CODE> - is the document queue we'll be stuffing.<DD><CODE>n</CODE> - represents the number of threads that will be processing queued stuff, NOT the
+<DT><B>Parameters:</B><DD><CODE>documentQueue</CODE> - is the document queue we'll be stuffing.<DD><CODE>n</CODE> - represents the number of threads that will be processing queued stuff, NOT the
number of documents to be done at once!
<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/system/ExpireThread.OutputRemoveActivity.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireThread.OutputRemoveActivity.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireThread.OutputRemoveActivity.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireThread.OutputRemoveActivity.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
ExpireThread.OutputRemoveActivity
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -295,13 +295,13 @@ public void <B>recordActivity</B>(java.l
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html#recordActivity(java.lang.Long, java.lang.String, java.lang.Long, java.lang.String, java.lang.String, java.lang.String)">recordActivity</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html" title="interface in org.apache.manifoldcf.agents.interfaces">IOutputHistoryActivity</A></CODE></DL>
</DD>
<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>entityURI</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>entityURI</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.
<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/system/ExpireThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ExpireThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
ExpireThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/FinisherThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/FinisherThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/FinisherThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/FinisherThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
FinisherThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/IdleCleanupThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/IdleCleanupThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/IdleCleanupThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/IdleCleanupThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
IdleCleanupThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,7 +104,7 @@ java.lang.Object
</PRE>
<P>
-This thread periodically calls the cleanup method in all connected repository connectors. The ostensible purpose
+This thread periodically calls the cleanup method in all connected repository connectors. The ostensible purpose
is to allow the connectors to shutdown idle connections etc.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobDeleteThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobDeleteThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobDeleteThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobDeleteThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
JobDeleteThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,9 +104,9 @@ java.lang.Object
</PRE>
<P>
-This class represents the job delete thread. This thread's job is to find jobs that are marked for delete
- and which have no remaining ingested documents, and delete them.
- The query which locates these jobs is in fact where all the work is; this query finds only jobs where there are
+This class represents the job delete thread. This thread's job is to find jobs that are marked for delete
+ and which have no remaining ingested documents, and delete them.
+ The query which locates these jobs is in fact where all the work is; this query finds only jobs where there are
no remaining documents in the "completed", "purgatory", or "pendingpurgatory" states, which are in the "READYFORDELETE" state.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.NotificationResetManager.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.NotificationResetManager.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.NotificationResetManager.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.NotificationResetManager.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
JobNotificationThread.NotificationResetManager
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,8 +104,8 @@ java.lang.Object
</PRE>
<P>
-Class which handles reset for seeding thread pool (of which there's
- typically only one member). The reset action here
+Class which handles reset for seeding thread pool (of which there's
+ typically only one member). The reset action here
is to move the status of jobs back from "seeding" to normal.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputAndRepositoryConnection.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputAndRepositoryConnection.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputAndRepositoryConnection.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputAndRepositoryConnection.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
JobNotificationThread.OutputAndRepositoryConnection
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputNotifyActivity.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputNotifyActivity.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputNotifyActivity.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.OutputNotifyActivity.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
JobNotificationThread.OutputNotifyActivity
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -295,13 +295,13 @@ public void <B>recordActivity</B>(java.l
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html#recordActivity(java.lang.Long, java.lang.String, java.lang.Long, java.lang.String, java.lang.String, java.lang.String)">recordActivity</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/agents/interfaces/IOutputHistoryActivity.html" title="interface in org.apache.manifoldcf.agents.interfaces">IOutputHistoryActivity</A></CODE></DL>
</DD>
<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>entityURI</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>entityURI</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.
<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/system/JobNotificationThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobNotificationThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
JobNotificationThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,7 +104,7 @@ java.lang.Object
</PRE>
<P>
-This class represents the thread that notices jobs that have completed their "notify connector" phase, and resets them back to
+This class represents the thread that notices jobs that have completed their "notify connector" phase, and resets them back to
inactive.
<P>
@@ -126,7 +126,7 @@ This class represents the thread that no
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/system/JobNotificationThread.NotificationResetManager.html" title="class in org.apache.manifoldcf.crawler.system">JobNotificationThread.NotificationResetManager</A></B></CODE>
<BR>
- Class which handles reset for seeding thread pool (of which there's
+ Class which handles reset for seeding thread pool (of which there's
typically only one member).</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobResetThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobResetThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobResetThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobResetThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
JobResetThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,7 +104,7 @@ java.lang.Object
</PRE>
<P>
-This class represents the thread that notices jobs that have completed their shutdown phase, and puts them in the
+This class represents the thread that notices jobs that have completed their shutdown phase, and puts them in the
"notify connector" state.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobStartThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobStartThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobStartThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/JobStartThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
JobStartThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,7 +104,7 @@ java.lang.Object
</PRE>
<P>
-This class describes the thread that starts up jobs. Basically, it periodically evaluates whether any jobs are ready to begin,
+This class describes the thread that starts up jobs. Basically, it periodically evaluates whether any jobs are ready to begin,
if it finds any, starts them.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/Logging.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/Logging.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/Logging.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/Logging.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
Logging
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.InitializationThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.InitializationThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.InitializationThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.InitializationThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
ManifoldCF.InitializationThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ManifoldCF.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
ManifoldCF
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -3002,7 +3002,7 @@ public static void <B>resetAllDocumentPr
long currentTime)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Reset all (active) document priorities. This operation may occur due to various externally-triggered
+<DD>Reset all (active) document priorities. This operation may occur due to various externally-triggered
events, such a job abort, pause, resume, wait, or unwait.
<P>
<DD><DL>
@@ -3126,8 +3126,8 @@ decodeAPIPathElement</H3>
public static java.lang.String <B>decodeAPIPathElement</B>(java.lang.String startingPathElement)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Decode path element.
- Path elements in the API world cannot have "/" characters, or they become impossible to parse. This method undoes
+<DD>Decode path element.
+ Path elements in the API world cannot have "/" characters, or they become impossible to parse. This method undoes
escaping that prevents "/" from appearing.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocument.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocument.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocument.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocument.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:32 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
QueuedDocument
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,12 +100,12 @@ java.lang.Object
</PRE>
<P>
-This class represents a document that will be placed on the document queue, and will be
- processed by a worker thread.
- The reason that DocumentDescription by itself is not used has to do with the fact that
- a good deal more information about the document must be obtained in order to find the
- last version ingested (which must be done in bulk, for performance reasons). Since we
- are finding everything anyway, it makes sense to put what we have in a structure so
+This class represents a document that will be placed on the document queue, and will be
+ processed by a worker thread.
+ The reason that DocumentDescription by itself is not used has to do with the fact that
+ a good deal more information about the document must be obtained in order to find the
+ last version ingested (which must be done in bulk, for performance reasons). Since we
+ are finding everything anyway, it makes sense to put what we have in a structure so
that the worker threads don't need to repeat what the stuffer thread did.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocumentSet.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocumentSet.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocumentSet.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/QueuedDocumentSet.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:33 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
QueuedDocumentSet
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -100,7 +100,7 @@ java.lang.Object
</PRE>
<P>
-This class is what's actually queued. It is immutable and it represents an array or set of QueuedDocument objects, all of which
+This class is what's actually queued. It is immutable and it represents an array or set of QueuedDocument objects, all of which
will be processed by a single worker thread in bulk.
<P>
@@ -282,8 +282,8 @@ jobDescription</H3>
<PRE>
protected <A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IJobDescription.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IJobDescription</A> <B>jobDescription</B></PRE>
<DL>
-<DD>The job description that applies to this document set. There is no guarantee that
- this won't change before we get around to processing the document; therefore any
+<DD>The job description that applies to this document set. There is no guarantee that
+ this won't change before we get around to processing the document; therefore any
job-based metadata changes will also need to go through the queue mechanism.
<P>
<DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ResetManager.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ResetManager.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ResetManager.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/ResetManager.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:33 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
ResetManager
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -103,17 +103,17 @@ java.lang.Object
</PRE>
<P>
-The reset manager basically keeps track of threads that work together. If the
- threads get hosed as a result of problems, then certain resets need to be done.
- Each instance of this manager therefore tracks all the threads which depend or
- affect a condition that needs explicit resetting. When a thread recognizes that
- the database (or whatever resource) is potentially in a state where a reset for
- the particular condition is required, then the corresponding reset manager object
- will cause all dependent threads to block, until they are all accounted for.
- Then, the corrective reset is done, and the threads are released (with a signal
- corresponding to the fact that a reset occurred returned).
-
- This class is meant to be extended in order to implement the exact reset
+The reset manager basically keeps track of threads that work together. If the
+ threads get hosed as a result of problems, then certain resets need to be done.
+ Each instance of this manager therefore tracks all the threads which depend or
+ affect a condition that needs explicit resetting. When a thread recognizes that
+ the database (or whatever resource) is potentially in a state where a reset for
+ the particular condition is required, then the corresponding reset manager object
+ will cause all dependent threads to block, until they are all accounted for.
+ Then, the corrective reset is done, and the threads are released (with a signal
+ corresponding to the fact that a reset occurred returned).
+
+ This class is meant to be extended in order to implement the exact reset
functionality required.
<P>
@@ -357,10 +357,10 @@ public boolean <B>waitForReset</B>(<A HR
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A>,
java.lang.InterruptedException</PRE>
<DL>
-<DD>Enter "wait" state for current thread.
- This method is the main logic for the reset manager. A thread
- calls this method, which may block until all other threads are
- waiting too. Then, the reset method is called by exactly ONE
+<DD>Enter "wait" state for current thread.
+ This method is the main logic for the reset manager. A thread
+ calls this method, which may block until all other threads are
+ waiting too. Then, the reset method is called by exactly ONE
of the waiting threads, and they all are released.
<P>
<DD><DL>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingActivity.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingActivity.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingActivity.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingActivity.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:33 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
SeedingActivity
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -103,7 +103,7 @@ java.lang.Object
</PRE>
<P>
-This class represents the things you can do with the framework while
+This class represents the things you can do with the framework while
seeding.
<P>
@@ -321,7 +321,7 @@ This class represents the things you can
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/system/SeedingActivity.html#addUnqueuedSeedDocument(java.lang.String)">addUnqueuedSeedDocument</A></B>(java.lang.String documentIdentifier)</CODE>
<BR>
- This method receives document identifiers that should be considered part of the seeds, but do not need to be
+ This method receives document identifiers that should be considered part of the seeds, but do not need to be
queued for processing at this time.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
@@ -635,15 +635,15 @@ public void <B>addSeedDocument</B>(java.
java.lang.String[] prereqEventNames)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Record a "seed" document identifier.
- Seeds passed to this method will be loaded into the job's queue at the beginning of the
- job's execution, and for continuous crawling jobs, periodically throughout the crawl.
-
- All documents passed to this method are placed on the "pending documents" list, and are marked as being seed
- documents. All pending documents will be processed to determine if they have changed or have been deleted.
- It is not a big problem if the connector chooses to put more documents onto the pending list than are
- strictly necessary; it is merely a question of overall work required.
-
+<DD>Record a "seed" document identifier.
+ Seeds passed to this method will be loaded into the job's queue at the beginning of the
+ job's execution, and for continuous crawling jobs, periodically throughout the crawl.
+
+ All documents passed to this method are placed on the "pending documents" list, and are marked as being seed
+ documents. All pending documents will be processed to determine if they have changed or have been deleted.
+ It is not a big problem if the connector chooses to put more documents onto the pending list than are
+ strictly necessary; it is merely a question of overall work required.
+
Note that it is always ok to send MORE documents rather than less to this method.
<P>
<DD><DL>
@@ -663,15 +663,15 @@ addSeedDocument</H3>
public void <B>addSeedDocument</B>(java.lang.String documentIdentifier)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>Record a "seed" document identifier.
- Seeds passed to this method will be loaded into the job's queue at the beginning of the
- job's execution, and for continuous crawling jobs, periodically throughout the crawl.
-
- All documents passed to this method are placed on the "pending documents" list, and are marked as being seed
- documents. All pending documents will be processed to determine if they have changed or have been deleted.
- It is not a big problem if the connector chooses to put more documents onto the pending list than are
- strictly necessary; it is merely a question of overall work required.
-
+<DD>Record a "seed" document identifier.
+ Seeds passed to this method will be loaded into the job's queue at the beginning of the
+ job's execution, and for continuous crawling jobs, periodically throughout the crawl.
+
+ All documents passed to this method are placed on the "pending documents" list, and are marked as being seed
+ documents. All pending documents will be processed to determine if they have changed or have been deleted.
+ It is not a big problem if the connector chooses to put more documents onto the pending list than are
+ strictly necessary; it is merely a question of overall work required.
+
Note that it is always ok to send MORE documents rather than less to this method.
<P>
<DD><DL>
@@ -691,19 +691,19 @@ addUnqueuedSeedDocument</H3>
public void <B>addUnqueuedSeedDocument</B>(java.lang.String documentIdentifier)
throws <A HREF="../../../../../org/apache/manifoldcf/core/interfaces/ManifoldCFException.html" title="class in org.apache.manifoldcf.core.interfaces">ManifoldCFException</A></PRE>
<DL>
-<DD>This method receives document identifiers that should be considered part of the seeds, but do not need to be
- queued for processing at this time. (This method is used to keep the hopcount tables up to date.) It is
- allowed to receive more identifiers than it strictly needs to, specifically identifiers that may have also been
- sent to the addSeedDocuments() method above. However, the connector must constrain the identifiers
- it sends by the document specification.
- This method is only required to be called at all if the connector supports hopcount determination (which it
+<DD>This method receives document identifiers that should be considered part of the seeds, but do not need to be
+ queued for processing at this time. (This method is used to keep the hopcount tables up to date.) It is
+ allowed to receive more identifiers than it strictly needs to, specifically identifiers that may have also been
+ sent to the addSeedDocuments() method above. However, the connector must constrain the identifiers
+ it sends by the document specification.
+ This method is only required to be called at all if the connector supports hopcount determination (which it
should signal by having more than zero legal relationship types returned by the getRelationshipTypes() method).
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/ISeedingActivity.html#addUnqueuedSeedDocument(java.lang.String)">addUnqueuedSeedDocument</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/ISeedingActivity.html" title="interface in org.apache.manifoldcf.crawler.interfaces">ISeedingActivity</A></CODE></DL>
</DD>
<DD><DL>
-<DT><B>Parameters:</B><DD><CODE>documentIdentifier</CODE> - is the identifier of the document to consider as a seed, but not to put in the
+<DT><B>Parameters:</B><DD><CODE>documentIdentifier</CODE> - is the identifier of the document to consider as a seed, but not to put in the
"pending" queue.
<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>
@@ -748,13 +748,13 @@ public void <B>recordActivity</B>(java.l
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IHistoryActivity.html#recordActivity(java.lang.Long, java.lang.String, java.lang.Long, java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">recordActivity</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/manifoldcf/crawler/interfaces/IHistoryActivity.html" title="interface in org.apache.manifoldcf.crawler.interfaces">IHistoryActivity</A></CODE></DL>
</DD>
<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>
@@ -790,9 +790,9 @@ public 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/system/SeedingThread.SeedingResetManager.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingThread.SeedingResetManager.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingThread.SeedingResetManager.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingThread.SeedingResetManager.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:33 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
SeedingThread.SeedingResetManager
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,8 +104,8 @@ java.lang.Object
</PRE>
<P>
-Class which handles reset for seeding thread pool (of which there's
- typically only one member). The reset action here
+Class which handles reset for seeding thread pool (of which there's
+ typically only one member). The reset action here
is to move the status of jobs back from "seeding" to normal.
<P>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SeedingThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:33 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
SeedingThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,10 +104,10 @@ java.lang.Object
</PRE>
<P>
-This class represents the background seeding thread. Its job is to add
- seeded documents from the connector periodically, during adaptive crawls
- (which continue until stopped). The actual use case is for creating a
- connector that handles RSS feeds, including keeping them current and
+This class represents the background seeding thread. Its job is to add
+ seeded documents from the connector periodically, during adaptive crawls
+ (which continue until stopped). The actual use case is for creating a
+ connector that handles RSS feeds, including keeping them current and
handling deletions.
<P>
@@ -129,7 +129,7 @@ This class represents the background see
<TD><CODE><B><A HREF="../../../../../org/apache/manifoldcf/crawler/system/SeedingThread.SeedingResetManager.html" title="class in org.apache.manifoldcf.crawler.system">SeedingThread.SeedingResetManager</A></B></CODE>
<BR>
- Class which handles reset for seeding thread pool (of which there's
+ Class which handles reset for seeding thread pool (of which there's
typically only one member).</TD>
</TR>
</TABLE>
Modified: incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SetPriorityThread.html
URL: http://svn.apache.org/viewvc/incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SetPriorityThread.html?rev=1345569&r1=1345568&r2=1345569&view=diff
==============================================================================
--- incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SetPriorityThread.html (original)
+++ incubator/lcf/site/publish/release/trunk/api/framework/org/apache/manifoldcf/crawler/system/SetPriorityThread.html Sat Jun 2 20:35:59 2012
@@ -2,12 +2,12 @@
<!--NewPage-->
<HTML>
<HEAD>
-<!-- Generated by javadoc (build 1.6.0_21) on Thu May 31 04:26:33 EDT 2012 -->
+<!-- Generated by javadoc (build 1.6.0_21) on Sat Jun 02 16:08:07 EDT 2012 -->
<TITLE>
SetPriorityThread
</TITLE>
-<META NAME="date" CONTENT="2012-05-31">
+<META NAME="date" CONTENT="2012-06-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
@@ -104,12 +104,12 @@ java.lang.Object
</PRE>
<P>
-This class describes a thread whose job it is to continuously reset document priorities, based on recent
- queuing activity. The goal is to evenly distribute queued documents across jobs and within classes of documents
- inside jobs.
- The way it works is for the thread to do some number of pending documents at a time. The documents are fetched in such
- a way as to get the ones that have been least recently assessed preferentially. The assessment process involves
- getting hold of a connector for the job that owns the document, and calculating the priority based on the recent
+This class describes a thread whose job it is to continuously reset document priorities, based on recent
+ queuing activity. The goal is to evenly distribute queued documents across jobs and within classes of documents
+ inside jobs.
+ The way it works is for the thread to do some number of pending documents at a time. The documents are fetched in such
+ a way as to get the ones that have been least recently assessed preferentially. The assessment process involves
+ getting hold of a connector for the job that owns the document, and calculating the priority based on the recent
history as maintained in the queueTracker object.
<P>