/*
- * Sone - Command.java - Copyright © 2011–2013 David Roden
+ * Sone - Command.java - Copyright © 2011–2019 David Roden
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
import net.pterodactylus.sone.freenet.SimpleFieldSetBuilder;
import freenet.support.SimpleFieldSet;
-import freenet.support.api.Bucket;
/**
* Implementation of an FCP interface for other clients or plugins to
* communicate with Sone.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public interface Command {
*
* @param parameters
* The parameters of the comand
- * @param data
- * The data of the command (may be {@code null})
- * @param accessType
- * The access type
* @return A reply to send back to the plugin
* @throws FcpException
* if an error processing the parameters occurs
*/
- public Response execute(SimpleFieldSet parameters, Bucket data, AccessType accessType) throws FcpException;
+ public Response execute(SimpleFieldSet parameters) throws FcpException;
/**
* The access type of the request.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public static enum AccessType {
/**
* Interface for command replies.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public static class Response {
/** The reply parameters. */
private final SimpleFieldSet replyParameters;
- /** The reply data, may be {@code null}. */
- private final byte[] data;
-
- /** The data bucket, may be {@code null}. */
- private final Bucket bucket;
-
/**
* Creates a new reply with the given parameters.
*
* The reply parameters
*/
public Response(String messageName, SimpleFieldSet replyParameters) {
- this(messageName, replyParameters, null, null);
- }
-
- /**
- * Creates a new reply with the given parameters.
- *
- * @param messageName
- * The message name
- * @param replyParameters
- * The reply parameters
- * @param data
- * The data of the reply (may be {@code null})
- */
- public Response(String messageName, SimpleFieldSet replyParameters, byte[] data) {
- this(messageName, replyParameters, data, null);
- }
-
- /**
- * Creates a new reply with the given parameters.
- *
- * @param messageName
- * The message name
- * @param replyParameters
- * The reply parameters
- * @param bucket
- * The bucket of the reply (may be {@code null})
- */
- public Response(String messageName, SimpleFieldSet replyParameters, Bucket bucket) {
- this(messageName, replyParameters, null, bucket);
- }
-
- /**
- * Creates a new reply with the given parameters.
- *
- * @param messageName
- * The message name
- * @param replyParameters
- * The reply parameters
- * @param data
- * The data of the reply (may be {@code null})
- * @param bucket
- * The bucket of the reply (may be {@code null})
- */
- private Response(String messageName, SimpleFieldSet replyParameters, byte[] data, Bucket bucket) {
this.messageName = messageName;
this.replyParameters = replyParameters;
- this.data = data;
- this.bucket = bucket;
}
/**
return new SimpleFieldSetBuilder(replyParameters).put("Message", messageName).get();
}
- /**
- * Returns whether the reply has reply data.
- *
- * @see #getData()
- * @return {@code true} if this reply has data, {@code false} otherwise
- */
- public boolean hasData() {
- return data != null;
- }
-
- /**
- * Returns the data of the reply.
- *
- * @return The data of the reply
- */
- public byte[] getData() {
- return data;
- }
-
- /**
- * Returns whether the reply has a data bucket.
- *
- * @see #getBucket()
- * @return {@code true} if the reply has a data bucket, {@code false}
- * otherwise
- */
- public boolean hasBucket() {
- return bucket != null;
- }
-
- /**
- * Returns the data bucket of the reply.
- *
- * @return The data bucket of the reply
- */
- public Bucket getBucket() {
- return bucket;
- }
-
}
/**
* Response implementation that can return an error message and an optional
* error code.
- *
- * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
public class ErrorResponse extends Response {