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;
27 * Interface for the core.
29 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
31 public interface Core {
34 * Adds the given listener to the list of registered listeners.
39 public void addCoreListener(CoreListener coreListener);
42 * Removes the given listener from the list of registered listeners.
45 * The listener to remove
47 public void removeCoreListener(CoreListener coreListener);
50 * Adds the given node to the core.
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
59 public boolean addNode(Node node) throws UnknownHostException;
62 * Removes the given node from the core.
67 public void removeNode(Node node);
70 * Returns the list of all configured nodes.
72 * @return All configured nodes
74 public List<Node> getNodes();
77 * Returns whether the core is currently connected to the given node.
81 * @return <code>true</code> if the core is currently connected to the node,
82 * <code>false</code> otherwise
84 public boolean isNodeConnected(Node node);
97 * Connects to the given node.
100 * The node to connect to
102 public void connectToNode(Node node);
105 * Disconnects from the given node.
108 * The node to disconnect from
110 public void disconnectFromNode(Node node);
113 * Creates a new project.
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
120 public void createProject() throws IOException, JSiteException;
123 * Inserts the given project on the given node.
126 * The node to use for the insert
128 * The project to insert
130 public void insertProject(Node node, Project project);
133 * Clones the given project. {@link CoreListener}s will be notified of the
134 * new clone via the {@link CoreListener#projectCloned(Project, Project)}
138 * The project to clone
140 public void cloneProject(Project project);
143 * Removes the given project.
146 * The project to remove
148 public void removeProject(Project project);
151 * Returns a list of all projects.
153 * @return A list of all projects
155 public List<Project> getProjects();