wamblee.org Git - utils/blob - crawler/kiss/src/org/wamblee/crawler/kiss/notification/Notifier.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 package org.wamblee.crawler.kiss.notification;
  17
  18 import java.io.IOException;
  19
  20 import javax.xml.transform.TransformerException;
  21
  22 import org.dom4j.Element;
  23
  24 /**
  25  * Object used to send notifications about the actions of the crawler.
  26  *
  27  */
  28 public interface Notifier {
  29
  30     /**
  31      * Sends a notification.
  32      *
  33      * @param aReport
  34      *            Report to send.
  35      */
  36     void send(Element aReport) throws NotificationException;
  37
  38     /**
  39      * Converts the report to html.
  40      * @param aReport Report to convert.
  41      * @return
  42      */
  43     String asHtml(Element aReport) throws IOException, TransformerException;
  44
  45     /**
  46      * Converts the report to text.
  47      * @param aReport Report to convert.
  48      * @return
  49      */
  50     String asText(Element aReport) throws IOException, TransformerException;
  51 }