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