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

   1 /*
   2  * jSite2 - NodeListener.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 listeners that want to be notified about node events.
  26  *
  27  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  28  * @version $Id$
  29  */
  30 public interface NodeListener extends EventListener {
  31
  32         /**
  33          * Notifies a listener that a node was added.
  34          *
  35          * @param node
  36          *            The node that was added
  37          */
  38         public void nodeAdded(Node node);
  39
  40         /**
  41          * Notifies a listener that a node was removed.
  42          *
  43          * @param node
  44          *            The node that was removed
  45          */
  46         public void nodeRemoved(Node node);
  47
  48         /**
  49          * Notifies a listener that a connection to the given node was established.
  50          *
  51          * @param node
  52          *            The node that is now connected
  53          */
  54         public void nodeConnected(Node node);
  55
  56         /**
  57          * Notifies a listener that a connection to a node has failed.
  58          *
  59          * @param node
  60          *            The node that could not be connected
  61          * @param cause
  62          *            The cause of the failure
  63          */
  64         public void nodeConnectionFailed(Node node, Throwable cause);
  65
  66         /**
  67          * Notifies a listener that a connection to the given node was severed. If
  68          * the listener needs the high-level client associated with the node for
  69          * anything else (like deregistering as listener from it) it should retrieve
  70          * the high-level client using {@link NodeManager#getHighLevelClient(Node)}
  71          * before this method returns!
  72          *
  73          * @param node
  74          *            The node that is now disconnected
  75          * @param throwable
  76          *            The exception that caused the disconnect, or <code>null</code>
  77          *            if there was no exception
  78          */
  79         public void nodeDisconnected(Node node, Throwable throwable);
  80
  81 }