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