2 * Sone - Command.java - Copyright © 2011–2020 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;
24 * Implementation of an FCP interface for other clients or plugins to
25 * communicate with Sone.
27 public interface Command {
30 * Executes the command, returning a reply that will be sent back to the
34 * The parameters of the comand
35 * @return A reply to send back to the plugin
36 * @throws FcpException
37 * if an error processing the parameters occurs
39 public Response execute(SimpleFieldSet parameters) throws FcpException;
42 * The access type of the request.
44 public static enum AccessType {
46 /** Access from another plugin. */
49 /** Access via restricted FCP. */
52 /** Access via FCP with full access. */
58 * Interface for command replies.
60 public static class Response {
62 /** The message name of the reponse. */
63 private final String messageName;
65 /** The reply parameters. */
66 private final SimpleFieldSet replyParameters;
69 * Creates a new reply with the given parameters.
73 * @param replyParameters
74 * The reply parameters
76 public Response(String messageName, SimpleFieldSet replyParameters) {
77 this.messageName = messageName;
78 this.replyParameters = replyParameters;
82 * Returns the reply parameters.
84 * @return The reply parameters
86 public SimpleFieldSet getReplyParameters() {
87 return new SimpleFieldSetBuilder(replyParameters).put("Message", messageName).get();
93 * Response implementation that can return an error message and an optional
96 public class ErrorResponse extends Response {
99 * Creates a new error response with the given message.
104 public ErrorResponse(String message) {
105 super("Error", new SimpleFieldSetBuilder().put("ErrorMessage", message).get());
109 * Creates a new error response with the given code and message.
116 public ErrorResponse(int code, String message) {
117 super("Error", new SimpleFieldSetBuilder().put("ErrorMessage", message).put("ErrorCode", code).get());