Package org.lockss.laaws.crawler.impl.pluggable

Class PluggableCrawl

java.lang.Object
org.lockss.laaws.crawler.impl.pluggable.PluggableCrawl
Direct Known Subclasses:
CmdLineCrawl
public abstract class PluggableCrawl extends Object
Basic Pluggable crawl - extend to provide functionality for a specific crawler

  • Field Details

    • crawlJob

      protected final org.lockss.util.rest.crawler.CrawlJob crawlJob
      The job for this crawl.

    • crawlDesc

      protected final org.lockss.util.rest.crawler.CrawlDesc crawlDesc
      Description of the crawl requested.

    • crawlerConfig

      protected final CrawlerConfig crawlerConfig
      The configuration of the crawler when this crawl began. This is stored so that a crawl will run with the parameters it was enqueued with.

    • crawlerStatus

      protected org.lockss.crawler.CrawlerStatus crawlerStatus
      The current status of a crawl as understood by the internal LOCKSS crawler.

    • au

      protected org.lockss.plugin.ArchivalUnit au

  • Constructor Details

    • PluggableCrawl

      protected PluggableCrawl(CrawlerConfig crawlerConfig, org.lockss.plugin.ArchivalUnit au, org.lockss.util.rest.crawler.CrawlJob crawlJob)
      Instantiates a new Pluggable crawl. This will initialize the basic structures the concrete implementations of this
      Parameters:
      crawlerConfig - the crawler config
      crawlJob - the crawl job

  • Method Details

    • getCrawlerStatus

      public org.lockss.crawler.CrawlerStatus getCrawlerStatus()
      Provides the crawler status.
      Returns:
      a CrawlerStatus with the crawler status.

    • setCrawlerStatus

      protected void setCrawlerStatus(org.lockss.crawler.CrawlerStatus crawlerStatus)
      Saves the crawler status.
      Parameters:
      crawlerStatus - A CrawlerStatus with the crawler status.

    • getCrawlStatus

      public CrawlStatus getCrawlStatus()
      Gets crawl status.
      Returns:
      the crawl status

    • getAuId

      public String getAuId()
      Gets au id.
      Returns:
      the au id

    • getCrawlerId

      public String getCrawlerId()
      Gets crawler id.
      Returns:
      the crawler id

    • getCrawlDesc

      public org.lockss.util.rest.crawler.CrawlDesc getCrawlDesc()
      Gets crawl desc.
      Returns:
      the crawl desc

    • getAu

      public org.lockss.plugin.ArchivalUnit getAu()

    • getCrawlerConfig

      public CrawlerConfig getCrawlerConfig()
      Gets crawler config.
      Returns:
      the crawler config

    • getCrawlKey

      public String getCrawlKey()
      Gets crawl key.
      Returns:
      the crawl key

    • getCrawlKind

      public String getCrawlKind()
      Gets crawl kind.
      Returns:
      the crawl kind

    • startCrawl

      public abstract org.lockss.crawler.CrawlerStatus startCrawl()
      Enqueue a crawl request.
      Returns:
      the crawler status

    • stopCrawl

      public abstract org.lockss.crawler.CrawlerStatus stopCrawl()
      Stop crawl crawler status.
      Returns:
      the crawler status

    • generateKey

      protected String generateKey()
      Generate key string.
      Returns:
      the string

    • getJobStatus

      public org.lockss.util.rest.crawler.JobStatus getJobStatus()
      Gets job status.
      Returns:
      the job status