2 * Sone - Command.java - Copyright © 2011–2016 David Roden
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 package net.pterodactylus.sone.freenet.fcp;
20 import net.pterodactylus.sone.freenet.SimpleFieldSetBuilder;
21 import freenet.support.SimpleFieldSet;
22 import freenet.support.api.Bucket;
25 * Implementation of an FCP interface for other clients or plugins to
26 * communicate with Sone.
28 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
30 public interface Command {
33 * Executes the command, returning a reply that will be sent back to the
37 * The parameters of the comand
39 * The data of the command (may be {@code null})
42 * @return A reply to send back to the plugin
43 * @throws FcpException
44 * if an error processing the parameters occurs
46 public Response execute(SimpleFieldSet parameters, Bucket data, AccessType accessType) throws FcpException;
49 * The access type of the request.
51 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
53 public static enum AccessType {
55 /** Access from another plugin. */
58 /** Access via restricted FCP. */
61 /** Access via FCP with full access. */
67 * Interface for command replies.
69 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
71 public static class Response {
73 /** The message name of the reponse. */
74 private final String messageName;
76 /** The reply parameters. */
77 private final SimpleFieldSet replyParameters;
80 * Creates a new reply with the given parameters.
84 * @param replyParameters
85 * The reply parameters
87 public Response(String messageName, SimpleFieldSet replyParameters) {
88 this.messageName = messageName;
89 this.replyParameters = replyParameters;
93 * Returns the reply parameters.
95 * @return The reply parameters
97 public SimpleFieldSet getReplyParameters() {
98 return new SimpleFieldSetBuilder(replyParameters).put("Message", messageName).get();
104 * Response implementation that can return an error message and an optional
107 * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
109 public class ErrorResponse extends Response {
112 * Creates a new error response with the given message.
117 public ErrorResponse(String message) {
118 super("Error", new SimpleFieldSetBuilder().put("ErrorMessage", message).get());
122 * Creates a new error response with the given code and message.
129 public ErrorResponse(int code, String message) {
130 super("Error", new SimpleFieldSetBuilder().put("ErrorMessage", message).put("ErrorCode", code).get());