2 * jSite - a tool for uploading websites into Freenet
3 * Copyright (C) 2006 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 de.todesbaum.jsite.application;
22 import java.util.EventListener;
25 * Interface for objects that want to be notified abount insert events.
27 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
29 public interface InsertListener extends EventListener {
32 * Enumeration for the different error situations.
34 * @author David ‘Bombe’ Roden <bombe@freenetproject.org>
36 public static enum ErrorType {
38 /** The key does already exist. */
41 /** The route to the key was not found. */
44 /** The data was not found. */
47 /** Error in the FCP communication. */
50 /** General error in the communication. */
55 * Notifies a listener that an insert has started.
58 * The project that is now being inserted
60 public void projectInsertStarted(Project project);
63 * Notifies a listener that the upload of a project has finished and the
64 * inserting will start now.
67 * The project that has been uploaded
69 public void projectUploadFinished(Project project);
72 * Notifies a listener that a project insert has generated a URI.
75 * The project being inserted
79 public void projectURIGenerated(Project project, String uri);
82 * Notifies a listener that an insert has made some progress.
85 * The project being inserted
87 * The number of succeeded blocks
89 * The number of failed blocks
91 * The number of fatally failed blocks
93 * The total number of blocks
95 * <code>true</code> if the total number of blocks has been
96 * finalized, <code>false</code> otherwise
98 public void projectInsertProgress(Project project, int succeeded, int failed, int fatal, int total, boolean finalized);
101 * Notifies a listener that a project insert has finished.
104 * The project being inserted
106 * <code>true</code> if the insert succeeded, <code>false</code>
109 * The cause of a failure, if any (may be <code>null</code>)
111 public void projectInsertFinished(Project project, boolean success, Throwable cause);