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