wamblee.org Git - utils/blob - crawler/kissweb/src/main/java/org/wamblee/crawler/kiss/scheduling/CrawlerScheduler.java

   1 /*
   2  * Copyright 2006 the original author or authors.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.wamblee.crawler.kiss.scheduling;
  18
  19 /**
  20  * Interface to the scheduler specific for working with the crawler.
  21  *
  22  * @author Erik Brakkee
  23  */
  24 public interface CrawlerScheduler {
  25
  26     /**
  27      * Initializes the scheduler.
  28      * @throws Exception In case of problems.
  29      */
  30     void initialize() throws Exception;
  31
  32     /**
  33      * Checks if the crawler is running.
  34      * @return True iff the crawler is running.
  35      * @throws Exception In case of problems.
  36      */
  37     boolean isCrawlerRunning() throws Exception;
  38
  39     /**
  40      * Schedules the crawler for immediate execution.
  41      * @throws Exception In case of problems.
  42      */
  43     void scheduleNow() throws Exception;
  44
  45     /**
  46      * Shuts down the scheduler.
  47      * @throws Exception In case of problems.
  48      */
  49     void shutdown() throws Exception;
  50 }