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>
33 public interface Core {
36 * Adds the given listener to the list of registered listeners.
41 public void addCoreListener(CoreListener coreListener);
44 * Removes the given listener from the list of registered listeners.
47 * The listener to remove
49 public void removeCoreListener(CoreListener coreListener);
52 * Adds the given node to the core.
56 * @return <code>true</code> if the node was added, <code>false</code>
57 * if it was not added because it was already known
58 * @throws UnknownHostException
59 * if the hostname of the node can not be resolved
61 public boolean addNode(Node node) throws UnknownHostException;
64 * Removes the given node from the core.
69 public void removeNode(Node node);
72 * Returns the list of all configured nodes.
74 * @return All configured nodes
76 public List<Node> getNodes();
79 * Returns whether the core is currently connected to the given node.
83 * @return <code>true</code> if the core is currently connected to the
84 * node, <code>false</code> otherwise
86 public boolean isNodeConnected(Node node);
99 * Connects to the given node.
102 * The node to connect to
104 public void connectToNode(Node node);
107 * Disconnects from the given node.
110 * The node to disconnect from
112 public void disconnectFromNode(Node node);
115 * Creates a new project. The returned {@link Project} will contain a newly
116 * generated key pair.
118 * @return A newly created project
119 * @throws IOException
120 * if an I/O error occured communicating with the node
121 * @throws JSiteException
122 * if there is a problem with the node
124 public Project createProject() throws IOException, JSiteException;
127 * Returns a list of all projects.
129 * @return A list of all projects
131 public List<Project> getProjects();