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