3 * Copyright © 2008 David Roden
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.
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.
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.
20 package net.pterodactylus.jsite.core;
22 import java.io.IOException;
23 import java.net.UnknownHostException;
24 import java.util.List;
25 import java.util.concurrent.Executor;
28 * Interface for the core.
30 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
32 public interface Core {
35 * Adds the given listener to the list of registered listeners.
40 public void addCoreListener(CoreListener coreListener);
43 * Removes the given listener from the list of registered listeners.
46 * The listener to remove
48 public void removeCoreListener(CoreListener coreListener);
51 * Returns a thread pool.
53 * @return A thread pool
55 public Executor getThreadPool();
58 * Adds the given node to the core.
62 * @return <code>true</code> if the node was added, <code>false</code>
63 * if it was not added because it was already known
64 * @throws UnknownHostException
65 * if the hostname of the node can not be resolved
67 public boolean addNode(Node node) throws UnknownHostException;
70 * Removes the given node from the core.
75 public void removeNode(Node node);
78 * Returns the list of all configured nodes.
80 * @return All configured nodes
82 public List<Node> getNodes();
85 * Returns whether the core is currently connected to the given node.
89 * @return <code>true</code> if the core is currently connected to the
90 * node, <code>false</code> otherwise
92 public boolean isNodeConnected(Node node);
105 * Connects to the given node.
108 * The node to connect to
110 public void connectToNode(Node node);
113 * Disconnects from the given node.
116 * The node to disconnect from
118 public void disconnectFromNode(Node node);
121 * Creates a new project.
123 * @throws IOException
124 * if an I/O error occured communicating with the node
125 * @throws JSiteException
126 * if there is a problem with the node
128 public void createProject() throws IOException, JSiteException;
131 * Clones the given project. {@link CoreListener}s will be notified of the
132 * new clone via the {@link CoreListener#projectCloned(Project, Project)}
136 * The project to clone
138 public void cloneProject(Project project);
141 * Removes the given project.
144 * The project to remove
146 public void removeProject(Project project);
149 * Returns a list of all projects.
151 * @return A list of all projects
153 public List<Project> getProjects();