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