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

   1 /*
   2  * jSite2 - Core.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.io.IOException;
  23 import java.net.UnknownHostException;
  24 import java.util.List;
  25
  26 /**
  27  * Interface for the core.
  28  *
  29  * @author David ‘Bombe’ Roden &lt;bombe@freenetproject.org&gt;
  30  * @version $Id$
  31  */
  32 public interface Core {
  33
  34         /**
  35          * Adds the given listener to the list of registered listeners.
  36          *
  37          * @param coreListener
  38          *            The listener to add
  39          */
  40         public void addCoreListener(CoreListener coreListener);
  41
  42         /**
  43          * Removes the given listener from the list of registered listeners.
  44          *
  45          * @param coreListener
  46          *            The listener to remove
  47          */
  48         public void removeCoreListener(CoreListener coreListener);
  49
  50         /**
  51          * Adds the given node to the core.
  52          *
  53          * @param node
  54          *            The node to add
  55          * @return <code>true</code> if the node was added, <code>false</code>
  56          *         if it was not added because it was already known
  57          * @throws UnknownHostException
  58          *             if the hostname of the node can not be resolved
  59          */
  60         public boolean addNode(Node node) throws UnknownHostException;
  61
  62         /**
  63          * Removes the given node from the core.
  64          *
  65          * @param node
  66          *            The node to remove
  67          */
  68         public void removeNode(Node node);
  69
  70         /**
  71          * Returns the list of all configured nodes.
  72          *
  73          * @return All configured nodes
  74          */
  75         public List<Node> getNodes();
  76
  77         /**
  78          * Returns whether the core is currently connected to the given node.
  79          *
  80          * @param node
  81          *            The node to check
  82          * @return <code>true</code> if the core is currently connected to the
  83          *         node, <code>false</code> otherwise
  84          */
  85         public boolean isNodeConnected(Node node);
  86
  87         /**
  88          * Starts the core.
  89          */
  90         public void start();
  91
  92         /**
  93          * Stops the core.
  94          */
  95         public void stop();
  96
  97         /**
  98          * Connects to the given node.
  99          *
 100          * @param node
 101          *            The node to connect to
 102          */
 103         public void connectToNode(Node node);
 104
 105         /**
 106          * Disconnects from the given node.
 107          *
 108          * @param node
 109          *            The node to disconnect from
 110          */
 111         public void disconnectFromNode(Node node);
 112
 113         /**
 114          * Creates a new project. The returned {@link Project} will contain a newly
 115          * generated key pair.
 116          *
 117          * @return A newly created project
 118          * @throws IOException
 119          *             if an I/O error occured communicating with the node
 120          * @throws NoNodeException
 121          *             if no node is configured
 122          */
 123         public Project createProject() throws IOException, NoNodeException;
 124
 125         /**
 126          * Returns a list of all projects.
 127          *
 128          * @return A list of all projects
 129          */
 130         public List<Project> getProjects();
 131
 132 }