com.sapportals.wcm.service.crawler
Interface ICrawlerResultReceiver

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

All Known Subinterfaces:

ICrawlerListResultReceiver, ICrawlerPushedDeltaResultReceiver, ICrawlerPushedResultReceiver, ISpecialCrawler

Deprecated. as of NW04. The crawler service was replaced by the xcrawler service com.sapportals.wcm.service.xcrawler

public interface ICrawlerResultReceiver

Base interface for a result receiver.

Please note: This interface doesn't define any result methods, therefore one has to implement either ICrawlerListResultReceiver or ICrawlerPushedResultReceiver to get the results.

Copyright 2004 SAP AG

Method Summary

IResourceContext	getCrawlerContext() Deprecated. Called by the crawler to get a context to use for accessing the resources during the crawl.
java.lang.String	getCrawlerName(java.util.Locale locale) Deprecated. Called to get an descriptive name for the crawler.
WcmException	onCrawlException(java.lang.Exception exception, IResource resource) Deprecated. Called by the crawler when an exception occured during the crawl.
boolean	onCrawlStart(ICrawler crawler) Deprecated. Called by the crawler to signal the start of a crawl.
boolean	onCrawlStop() Deprecated. Called by the crawler to signal the end of a crawl.

Method Detail

getCrawlerName

public java.lang.String getCrawlerName(java.util.Locale locale)

Deprecated.

Called to get an descriptive name for the crawler.

Returns:

a String with the crawlers name.

getCrawlerContext

public IResourceContext getCrawlerContext()

Deprecated.

Called by the crawler to get a context to use for accessing the resources during the crawl. This is the first call to the result receiver.

Returns:

a IResourceContext with the context to use or null if the context cannot be retrieved. A null will stop the crawler!

onCrawlException

public WcmException onCrawlException(java.lang.Exception exception,
                                     IResource resource)

Deprecated.

Called by the crawler when an exception occured during the crawl. This method can be callend any time between onCrawlStart and onCrawlStop.

Parameters:

exception - a Exception with the original exception.

resource - the IResource which caused the exception, if available, or null.

Returns:

a WcmException with the exception to throw (will stop the crawl or null if the exception should be ignored.

onCrawlStart

public boolean onCrawlStart(ICrawler crawler)

Deprecated.

Called by the crawler to signal the start of a crawl. This is the second call to the result receiver, and the first for a crawl.

Parameters:

crawler - the ICrawler which performs the crawl.

Returns:

a boolean true if the crawl should be performed, false if the result receiver want's to stop this crawl.

onCrawlStop

public boolean onCrawlStop()

Deprecated.

Called by the crawler to signal the end of a crawl. This is the last call to the result receiver for a crawl.

Returns:

a boolean true if the crawled resources should be discarded, false if the delta list should be kept.