org.archive.hcc.client
Interface Crawler

All Superinterfaces:
Proxy
All Known Implementing Classes:
CrawlerImpl

public interface Crawler
extends Proxy

An interface representing an instance of a Crawler.

Author:
Daniel Bernstein (dbernstein@archive.org)

Method Summary
 java.lang.String addJob(JobOrder order)
          Adds a job to the pending job queue.
 boolean deleteCompletedCrawlJob(CompletedCrawlJob job)
          Deletes a job from the completed list.
 boolean deletePendingCrawlJob(PendingCrawlJob job)
          Deletes a job from the pending queue.
 void destroy()
          Destroys the crawler instance and all dependent objects.
 java.lang.String getVersion()
          Returns the Heritrix version.
 boolean isCrawling()
          Returns true if the crawler has a currently running job.
 boolean isPendingJobQueueRunning()
          Returns true if the pending job queue is running.
 java.util.Collection<CompletedCrawlJob> listCompletedCrawlJobs()
          Returns a list of completed jobs.
 java.util.Collection<PendingCrawlJob> listPendingCrawlJobs()
          Returns a list of pending jobs.
 void startPendingJobQueue()
          Starts the pending job queue.
 void stopPendingJobQueue()
          Stops the pending job queue.
 void terminateCurrentJob()
          Terminates the currently running job.
 
Methods inherited from interface org.archive.hcc.client.Proxy
getName
 

Method Detail

startPendingJobQueue

void startPendingJobQueue()
Starts the pending job queue. Does nothing if the queue is already started.


stopPendingJobQueue

void stopPendingJobQueue()
Stops the pending job queue. Does nothing if the queue is already stopped.


isPendingJobQueueRunning

boolean isPendingJobQueueRunning()
Returns true if the pending job queue is running.

Returns:

addJob

java.lang.String addJob(JobOrder order)
Adds a job to the pending job queue.

Parameters:
order -
Returns:

terminateCurrentJob

void terminateCurrentJob()
Terminates the currently running job. Does nothing if if no job is currently running.


isCrawling

boolean isCrawling()
Returns true if the crawler has a currently running job.

Returns:

getVersion

java.lang.String getVersion()
Returns the Heritrix version.

Returns:

destroy

void destroy()
Destroys the crawler instance and all dependent objects.


deletePendingCrawlJob

boolean deletePendingCrawlJob(PendingCrawlJob job)
Deletes a job from the pending queue.

Parameters:
job -
Returns:

deleteCompletedCrawlJob

boolean deleteCompletedCrawlJob(CompletedCrawlJob job)
                                throws ClusterException
Deletes a job from the completed list.

Parameters:
job -
Returns:
Throws:
ClusterException

listPendingCrawlJobs

java.util.Collection<PendingCrawlJob> listPendingCrawlJobs()
Returns a list of pending jobs.

Returns:

listCompletedCrawlJobs

java.util.Collection<CompletedCrawlJob> listCompletedCrawlJobs()
Returns a list of completed jobs.

Returns:


Copyright © 2005-2008 The Internet Archive. All Rights Reserved.