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;
26 import net.pterodactylus.jsite.project.Project;
29 * Interface for the core.
31 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
34 public interface Core {
37 * Adds the given listener to the list of registered listeners.
42 public void addCoreListener(CoreListener coreListener);
45 * Removes the given listener from the list of registered listeners.
48 * The listener to remove
50 public void removeCoreListener(CoreListener coreListener);
53 * Adds the given node to the core.
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
62 public boolean addNode(Node node) throws UnknownHostException;
65 * Removes the given node from the core.
70 public void removeNode(Node node);
73 * Returns the list of all configured nodes.
75 * @return All configured nodes
77 public List<Node> getNodes();
80 * Returns whether the core is currently connected to the given node.
84 * @return <code>true</code> if the core is currently connected to the
85 * node, <code>false</code> otherwise
87 public boolean isNodeConnected(Node node);
100 * Connects to the given node.
103 * The node to connect to
105 public void connectToNode(Node node);
108 * Disconnects from the given node.
111 * The node to disconnect from
113 public void disconnectFromNode(Node node);
116 * Creates a new project. The returned {@link Project} will contain a newly
117 * generated key pair.
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
125 public Project createProject() throws IOException, JSiteException;
128 * Returns a list of all projects.
130 * @return A list of all projects
132 public List<Project> getProjects();