src/net/pterodactylus/jsite/core/RequestListener.java

   1 /*
   2  * jSite2 - RequestListener.java -
   3  * Copyright © 2008 David Roden
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 package net.pterodactylus.jsite.core;
  21
  22 import java.util.EventListener;
  23
  24 /**
  25  * Interface for objects that want to be notified on request events.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  * @version $Id$
  29  */
  30 public interface RequestListener extends EventListener {
  31
  32         /**
  33          * Notifies a listener that a request was added to a node.
  34          *
  35          * @param request
  36          *            The request that was added
  37          */
  38         public void requestAdded(Request request);
  39
  40         /**
  41          * Notifies a listener that a request made progress.
  42          *
  43          * @param request
  44          *            The request
  45          */
  46         public void requestProgressed(Request request);
  47
  48         /**
  49          * Notifies a listener that a request was removed.
  50          *
  51          * @param request
  52          *            The request that was removed
  53          */
  54         public void requestRemoved(Request request);
  55
  56         /**
  57          * Notifies a listener that a Put request has generated a URI.
  58          *
  59          * @param request
  60          *            The request that generated a URI
  61          * @param uri
  62          *            The generated URI
  63          */
  64         public void requestGeneratedURI(Request request, String uri);
  65
  66         /**
  67          * Notifies a listener that a request has completed.
  68          *
  69          * @param request
  70          *            The finished request
  71          */
  72         public void requestFinished(Request request);
  73
  74 }