com.sapportals.wcm.service.xcrawler
Interface IXCrawlerPushedResultReceiver

[contained in: com.sap.km.cm.service.base.par - km.shared.service.xcrawler_api.jar]

All Superinterfaces:

IXCrawlerResultReceiver

public interface IXCrawlerPushedResultReceiver

extends IXCrawlerResultReceiver

Result receiver which receives the result of a crawl as single RIDs as the crawl goes on.

Version for normal crawls.

Copyright (c) SAP AG 2003

Method Summary

void	finalGetFaulty(java.util.ArrayList faulty) Final call to get the RIDs which could not be processed by the receiver.
void	indicateStop() Indicate a crawler stop. When this method is called any pending calls to receive() must return immediately because the crawler is stopping. The method may be called multiple times before the crawler finally stops.
boolean	receive(RID rid, java.util.ArrayList faulty) Receive a resource.

Methods inherited from interface com.sapportals.wcm.service.xcrawler.IXCrawlerResultReceiver

approveCollectionCrawling, crawlFailed, crawlFinished, crawlStarted, crawlStopped, getResourceContext

Method Detail

receive

public boolean receive(RID rid,
                       java.util.ArrayList faulty)
                throws java.lang.Exception

Receive a resource.

Parameters:

rid - of the resource

faulty - list of previously provided RIDs which could not be processed by the receiver and shall be treated as erroneous by the crawler (might include the RID passed in this call)

Returns:

true to continue the crawl, false to stop it

Throws:

thrown - in case of error; the exception will not affect the ongoing crawl

indicateStop

public void indicateStop()
                  throws java.lang.Exception

Indicate a crawler stop.
When this method is called any pending calls to receive() must return immediately because the crawler is stopping.
The method may be called multiple times before the crawler finally stops.

Throws:

thrown - in case of error; the exception will not affect the ongoing crawl

finalGetFaulty

public void finalGetFaulty(java.util.ArrayList faulty)
                    throws java.lang.Exception

Final call to get the RIDs which could not be processed by the receiver.

Parameters:

faulty - list of previously provided RIDs which could not be processed by the receiver and shall be treated as erroneous by the crawler (might include the RID passed in this call)

Throws:

thrown - in case of error; the exception will not affect the ongoing crawl