com.sapportals.wcm.service.crawler
Interface ICrawlerService

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

All Superinterfaces:

IService

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

public interface ICrawlerService

extends IService

Interface to the crawler service.

Crawler's scan a repository for resources, which match some specified conditions. There will be several types of crawlers (e.g. threaded and unthreaded, some which memorize the already visisted resources and some which don't).

Copyright 2004 SAP AG

Field Summary

static int

SUBFOLDER_CRAWLER Deprecated. special operation: result will contain folders only.

Method Summary

ICrawler	createCrawler(ICrawlerProfile profile, ICrawlerResultReceiver receiver, IResource startResource) Deprecated. Create a new crawler from a given profile.
ICrawler	createCrawler(ICrawlerProfile profile, ICrawlerResultReceiver receiver, IResourceList startResources) Deprecated. Create a new crawler from a given profile.
ICrawler	createCrawler(java.lang.String type, ICrawlerResultReceiver receiver, IResource startResource) Deprecated. Create a new crawler (same as createCrawler(receiver, startResourceICrawler.FULL_DEPTH, false, false, false, null)).
ICrawler	createCrawler(java.lang.String type, ICrawlerResultReceiver receiver, IResource startResource, AbstractSpecialCrawlerParameters parameters) Deprecated. Create a new crawler for the given parameters.
ICrawler	createCrawler(java.lang.String type, ICrawlerResultReceiver receiver, IResource startResource, int depth, boolean internalLinkFlag, boolean externalLinkFlag, boolean includeVersionsFlag, IGenericQuery propertyQuery) Deprecated. Create a new crawler for the given parameters.
ICrawler	createCrawler(java.lang.String type, ICrawlerResultReceiver receiver, IResourceList startResources) Deprecated. Create a new crawler (same as createCrawler(receiver, startResourceICrawler.FULL_DEPTH, false, false, false, null)).
ICrawler	createCrawler(java.lang.String type, ICrawlerResultReceiver receiver, IResourceList startResources, AbstractSpecialCrawlerParameters parameters) Deprecated. Create a new crawler for the given parameters.
ICrawler	createCrawler(java.lang.String type, ICrawlerResultReceiver receiver, IResourceList startResources, int depth, boolean internalLinkFlag, boolean externalLinkFlag, boolean includeVersionsFlag, IGenericQuery propertyQuery) Deprecated. Create a new crawler for the given parameters.
ICrawlerQueue	createCrawlerQueue(java.lang.String id, int size) Deprecated. Create a new crawler queue.
ICrawlerList	createEmptyCrawlerList() Deprecated. Get an empty crawler list.
ICrawlerProfileList	createEmptyProfileList() Deprecated. Get an empty profile list.
IScheduledCrawlerList	createEmptyScheduledCrawlerList() Deprecated. Get an empty scheduled crawler list.
IScheduledCrawler	createScheduledCrawler(java.lang.String scheduledCrawlerID, ICrawler crawler, ISchedulerTimeTable timetable, java.util.Properties properties) Deprecated. Create a new scheduled crawler.
ICrawlerQueue	deleteCrawlerQueue(java.lang.String id) Deprecated. Delete an existing crawler queue.
IScheduledCrawler	deleteScheduledCrawler(IScheduledCrawler crawler) Deprecated. Delete a scheduled crawler.
ICrawlerList	getAllCrawlers() Deprecated. Get a a list of all crawlers (crawling non-scheduled and all scheduled).
ICrawlerProfileList	getAllProfiles() Deprecated. Get a list of all available parameter profiles for a given ID.
IScheduledCrawlerList	getAllScheduledCrawlers() Deprecated. Get a a list of all scheduled crawlers.
ICrawler	getCrawler(java.lang.String crawlerID) Deprecated. Get a specific crawler by it's ID.
ICrawlerQueue	getCrawlerQueue(java.lang.String id) Deprecated. Get a crawler queue.
java.util.Collection	getCrawlerTypes() Deprecated. Get a list of available crawler types.
java.lang.String	getDefaultCrawlerType() Deprecated. Get the default crawler type.
ICrawlerProfile	getProfile(java.lang.String id) Deprecated. Get a parameter profile for a given ID.
IScheduledCrawler	getScheduledCrawler(java.lang.String crawlerID) Deprecated. Get a specific scheduled crawler by it's ID.
ISpecialCrawler	getSpecialCrawler(AbstractSpecialCrawlerParameters parameters, IResourceContext context, IResource startResource) Deprecated. Get a special crawler for a specific operation, e.g. an SUBFOLDER_CRAWLER to get the subfolders of the given start resources.
ISpecialCrawler	getSpecialCrawler(AbstractSpecialCrawlerParameters parameters, IResourceContext context, IResourceList startResources) Deprecated. Get a special crawler for a specific operation, e.g. an SUBFOLDER_CRAWLER to get the subfolders of the given start resources.
IScheduledCrawler	resumeScheduledCrawler(IScheduledCrawler crawler) Deprecated. Resume a suspended scheduled crawler ((re)activate it).
IScheduledCrawler	suspendScheduledCrawler(IScheduledCrawler crawler) Deprecated. Suspend a scheduled crawler (inactivate it).
IScheduledCrawler	updateScheduledCrawler(IScheduledCrawler crawler) Deprecated. Update a scheduled crawler.

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Field Detail

SUBFOLDER_CRAWLER

public static final int SUBFOLDER_CRAWLER

Deprecated.

special operation: result will contain folders only.

Method Detail

getSpecialCrawler

public ISpecialCrawler getSpecialCrawler(AbstractSpecialCrawlerParameters parameters,
                                         IResourceContext context,
                                         IResource startResource)
                                  throws WcmException

Deprecated.

Get a special crawler for a specific operation, e.g. an SUBFOLDER_CRAWLER to get the subfolders of the given start resources. A special crawler has a predefined list result receiver.
Note: special crawlers can not be used as scheduled crawlers.

Parameters:

context - the IResourceContext to use for the crawl.

parameters - some AbstractSpecialCrawlerParameters which defines the behavior of the crawler.

startResource - the IResource to use as a starting point for the crawl.

Returns:

an ISpecialCrawler for the given paremeter set.

Throws:

WcmException - if the new crawler can not be created.

getSpecialCrawler

public ISpecialCrawler getSpecialCrawler(AbstractSpecialCrawlerParameters parameters,
                                         IResourceContext context,
                                         IResourceList startResources)
                                  throws WcmException

Deprecated.

Get a special crawler for a specific operation, e.g. an SUBFOLDER_CRAWLER to get the subfolders of the given start resources. A special crawler has a predefined list result receiver.
Note: special crawlers can not be used as scheduled crawlers.

Parameters:

context - the IResourceContext to use for the crawl.

parameters - some AbstractSpecialCrawlerParameters which defines the behavior of the crawler.

startResources - an IResourceList with the resources to use as the starting points for the crawl.

Returns:

an ISpecialCrawler for the given paremeter set.

Throws:

WcmException - if the new crawler can not be created.

getCrawlerTypes

public java.util.Collection getCrawlerTypes()

Deprecated.

Get a list of available crawler types.

Returns:

a Collection of Strings with the available crawler types.

getDefaultCrawlerType

public java.lang.String getDefaultCrawlerType()

Deprecated.

Get the default crawler type.

Returns:

a Strings with the default crawler type.

getCrawler

public ICrawler getCrawler(java.lang.String crawlerID)
                    throws WcmException

Deprecated.

Get a specific crawler by it's ID.

Parameters:

crawlerID - a String with the ID of the desired crawler.

Returns:

the ICrawler for the given ID or null, if no crawler exists with that id.

Throws:

WcmException - if an error occured while searching the list of crawlers.

getAllCrawlers

public ICrawlerList getAllCrawlers()
                            throws WcmException

Deprecated.

Get a a list of all crawlers (crawling non-scheduled and all scheduled).

Returns:

an ICrawlerList with all crawling non-scheduled and all scheduled crawlers (may be empty).

Throws:

WcmException - if an error occured while getting the list of crawlers.

createEmptyCrawlerList

public ICrawlerList createEmptyCrawlerList()

Deprecated.

Get an empty crawler list.

Returns:

an empty ICrawlerList.

getProfile

public ICrawlerProfile getProfile(java.lang.String id)
                           throws WcmException

Deprecated.

Get a parameter profile for a given ID.

Parameters:

id - a String with the ID of the desired profile.

Returns:

a ICrawlerProfile with the parameters for a crawler or null if the profile does not exist for the given ID.

Throws:

WcmException - if an error occured while getting the profile.

getAllProfiles

public ICrawlerProfileList getAllProfiles()
                                   throws WcmException

Deprecated.

Get a list of all available parameter profiles for a given ID.

Returns:

a ICrawlerProfileList with the all available parameter profiles for a crawler.

Throws:

WcmException - if an error occured while getting the profiles.

createEmptyProfileList

public ICrawlerProfileList createEmptyProfileList()

Deprecated.

Get an empty profile list.

Returns:

an empty ICrawlerProfileList.

getCrawlerQueue

public ICrawlerQueue getCrawlerQueue(java.lang.String id)

Deprecated.

Get a crawler queue.

Parameters:

id - a String with the unique id for the queue.

size - an int with the size for the queue.

Returns:

a ICrawlerQueue for queueing crawler or null if no queue is available for the given id.

createCrawlerQueue

public ICrawlerQueue createCrawlerQueue(java.lang.String id,
                                        int size)
                                 throws WcmException

Deprecated.

Create a new crawler queue.

Parameters:

id - a String with the unique id for the queue.

size - an int with the size for the queue.

Returns:

a ICrawlerQueue for queueing crawler.

Throws:

WcmException - if the new queue can not be created, for example if the queue already exists.

deleteCrawlerQueue

public ICrawlerQueue deleteCrawlerQueue(java.lang.String id)
                                 throws WcmException

Deprecated.

Delete an existing crawler queue.

Parameters:

id - a String with the id of the queue to delete.

Returns:

the ICrawlerQueue deleted crawler queue.

Throws:

WcmException - if the queue can not be deleted. for example if the queue does not exist.

createCrawler

public ICrawler createCrawler(ICrawlerProfile profile,
                              ICrawlerResultReceiver receiver,
                              IResource startResource)
                       throws WcmException

Deprecated.

Create a new crawler from a given profile.

Parameters:

profile - a ICrawlerProfile with the parameters for this crawler.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResource - an IResource with the resources to use as the starting point for the crawl.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

createCrawler

public ICrawler createCrawler(ICrawlerProfile profile,
                              ICrawlerResultReceiver receiver,
                              IResourceList startResources)
                       throws WcmException

Deprecated.

Create a new crawler from a given profile.

Parameters:

profile - a ICrawlerProfile with the parameters for this crawler.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResources - an IResourceList with the resources to use as the starting points for the crawl.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

createCrawler

public ICrawler createCrawler(java.lang.String type,
                              ICrawlerResultReceiver receiver,
                              IResourceList startResources)
                       throws WcmException

Deprecated.

Create a new crawler (same as createCrawler(receiver, startResourceICrawler.FULL_DEPTH, false, false, false, null)).

Parameters:

type - a String with the crawler's type.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResources - an IResourceList with the resources to use as the starting points for the crawl.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

createCrawler

public ICrawler createCrawler(java.lang.String type,
                              ICrawlerResultReceiver receiver,
                              IResource startResource)
                       throws WcmException

Deprecated.

Create a new crawler (same as createCrawler(receiver, startResourceICrawler.FULL_DEPTH, false, false, false, null)).

Parameters:

type - a String with the crawler's type.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResource - the IResource to use as a starting point for the crawl.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

createCrawler

public ICrawler createCrawler(java.lang.String type,
                              ICrawlerResultReceiver receiver,
                              IResourceList startResources,
                              int depth,
                              boolean internalLinkFlag,
                              boolean externalLinkFlag,
                              boolean includeVersionsFlag,
                              IGenericQuery propertyQuery)
                       throws WcmException

Deprecated.

Create a new crawler for the given parameters.

Parameters:

type - a String with the crawler's type.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResources - the IResourceList to use for the starting points for the crawl.

depth - an int with the maximum hierarchy depth to crawl.

internalLinkFlag - a boolean true if the crawler should follow internal links, false if not.

externalLinkFlag - a boolean true if the crawler should follow external links, false if not.

includeVersionsFlag - a boolean true if the crawler should include document versions, false if not.

query - a IGenericQuery with an property query expression, null if no property query should be performed.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

createCrawler

public ICrawler createCrawler(java.lang.String type,
                              ICrawlerResultReceiver receiver,
                              IResource startResource,
                              int depth,
                              boolean internalLinkFlag,
                              boolean externalLinkFlag,
                              boolean includeVersionsFlag,
                              IGenericQuery propertyQuery)
                       throws WcmException

Deprecated.

Create a new crawler for the given parameters.

Parameters:

type - a String with the crawler's type.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResource - the IResource to use as a starting point for the crawl.

depth - an int with the maximum hierarchy depth to crawl.

internalLinkFlag - a boolean true if the crawler should follow internal links, false if not.

externalLinkFlag - a boolean true if the crawler should follow external links, false if not.

includeVersionsFlag - a boolean true if the crawler should include document versions, false if not.

query - a IGenericQuery with an property query expression, null if no property query should be performed.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

createCrawler

public ICrawler createCrawler(java.lang.String type,
                              ICrawlerResultReceiver receiver,
                              IResourceList startResources,
                              AbstractSpecialCrawlerParameters parameters)
                       throws WcmException

Deprecated.

Create a new crawler for the given parameters.

Parameters:

type - a String with the crawler's type.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResources - the IResourceList to use with the starting points for the crawl.

depth - an int with the maximum hierarchy depth to crawl.

parameters - some AbstractSpecialCrawlerParameters with the parameters to use.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

createCrawler

public ICrawler createCrawler(java.lang.String type,
                              ICrawlerResultReceiver receiver,
                              IResource startResource,
                              AbstractSpecialCrawlerParameters parameters)
                       throws WcmException

Deprecated.

Create a new crawler for the given parameters.

Parameters:

type - a String with the crawler's type.

receiver - the ICrawlerResultReceiver for the crawlers result.

startResource - the IResource to use as a starting point for the crawl.

depth - an int with the maximum hierarchy depth to crawl.

parameters - some AbstractSpecialCrawlerParameters with the parameters to use.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created.

getScheduledCrawler

public IScheduledCrawler getScheduledCrawler(java.lang.String crawlerID)
                                      throws WcmException

Deprecated.

Get a specific scheduled crawler by it's ID.

Parameters:

crawlerID - a String with the ID of the desired crawler.

Returns:

the ICrawler for the given ID or null, if no crawler is scheduled with that id.

Throws:

WcmException - if an error occured while searching the list of scheduled crawlers.

getAllScheduledCrawlers

public IScheduledCrawlerList getAllScheduledCrawlers()
                                              throws WcmException

Deprecated.

Get a a list of all scheduled crawlers.

Returns:

an ICrawlerList with all scheduled crawlers (may be empty).

Throws:

WcmException - if an error occured while getting the list of scheduled crawlers.

createEmptyScheduledCrawlerList

public IScheduledCrawlerList createEmptyScheduledCrawlerList()

Deprecated.

Get an empty scheduled crawler list.

Returns:

an empty IScheduledCrawlerList.

createScheduledCrawler

public IScheduledCrawler createScheduledCrawler(java.lang.String scheduledCrawlerID,
                                                ICrawler crawler,
                                                ISchedulerTimeTable timetable,
                                                java.util.Properties properties)
                                         throws WcmException

Deprecated.

Create a new scheduled crawler.

Parameters:

scheduledCrawlerID - a String with the unique ID for this crawler.

crawler - a ICrawler to execute at the given time. Note: it's not possible to pass a special crawler for a scheduled crawler.

timetable - a ISchedulerTimeTable which defines the times when to execute the crawler.

properties - some Properties with the Strings to pass to the crawler.

Returns:

an new ICrawler.

Throws:

WcmException - if the new crawler can not be created, for example if the crawler is a special crawler.

suspendScheduledCrawler

public IScheduledCrawler suspendScheduledCrawler(IScheduledCrawler crawler)
                                          throws WcmException

Deprecated.

Suspend a scheduled crawler (inactivate it).

Parameters:

crawler - the IScheduledCrawler to suspend.

Returns:

the IScheduledCrawler with the suspended crawler, null if the crawlers's ID could not be found.

Throws:

WcmException - if the scheduled crawler could not be suspended.

resumeScheduledCrawler

public IScheduledCrawler resumeScheduledCrawler(IScheduledCrawler crawler)
                                         throws WcmException

Deprecated.

Resume a suspended scheduled crawler ((re)activate it).

Parameters:

crawler - the IScheduledCrawler to resume.

Returns:

the IScheduledCrawler with the resumed crawler, null if the crawlers's ID could not be found.

Throws:

WcmException - if the scheduled crawler could not be resumed.

updateScheduledCrawler

public IScheduledCrawler updateScheduledCrawler(IScheduledCrawler crawler)
                                         throws WcmException

Deprecated.

Update a scheduled crawler.

Parameters:

crawler - the IScheduledCrawler to update.

Returns:

the IScheduledCrawler with the updated crawler, null if the crawlers's ID could not be found.

Throws:

WcmException - if the scheduled crawler could not be updated.

deleteScheduledCrawler

public IScheduledCrawler deleteScheduledCrawler(IScheduledCrawler crawler)
                                         throws WcmException

Deprecated.

Delete a scheduled crawler.

Parameters:

crawler - the IScheduledCrawler to delete.

Returns:

the IScheduledCrawler with the deleted crawler, null if the crawlers's ID could not be found.

Throws:

WcmException - if the scheduled crawler could not be deleted.