Merge branch 'remove-removable-drive-plugin' into 'master'

Remove RemovableDrivePlugin, refactor plugin interface

Closes #25

See merge request akwizgran/briar!817

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/FileConstants.java

@@ -0,0 +1,6 @@
+package org.briarproject.bramble.api.plugin;
+
+public interface FileConstants {
+
+	String PROP_PATH = "path";
+}

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/Plugin.java

@@ -2,8 +2,9 @@ package org.briarproject.bramble.api.plugin;
 
 import org.briarproject.bramble.api.contact.ContactId;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
+import org.briarproject.bramble.api.properties.TransportProperties;
 
-import java.util.Collection;
+import java.util.Map;
 
 @NotNullByDefault
 public interface Plugin {
@@ -39,21 +40,19 @@ public interface Plugin {
 	boolean isRunning();
 
 	/**
-	 * Returns true if the plugin's {@link #poll(Collection)} method should be
-	 * called periodically to attempt to establish connections.
+	 * Returns true if the plugin should be polled periodically to attempt to
+	 * establish connections.
 	 */
 	boolean shouldPoll();
 
 	/**
-	 * Returns the desired interval in milliseconds between calls to the
-	 * plugin's {@link #poll(Collection)} method.
+	 * Returns the desired interval in milliseconds between polling attempts.
 	 */
 	int getPollingInterval();
 
 	/**
-	 * Attempts to establish connections to contacts, passing any created
-	 * connections to the callback. To avoid creating redundant connections,
-	 * the plugin may exclude the given contacts from polling.
+	 * Attempts to establish connections to the given contacts, passing any
+	 * created connections to the callback.
 	 */
-	void poll(Collection<ContactId> connected);
+	void poll(Map<ContactId, TransportProperties> contacts);
 }

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/PluginCallback.java

@@ -1,12 +1,9 @@
 package org.briarproject.bramble.api.plugin;
 
-import org.briarproject.bramble.api.contact.ContactId;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import org.briarproject.bramble.api.properties.TransportProperties;
 import org.briarproject.bramble.api.settings.Settings;
 
-import java.util.Map;
-
 /**
  * An interface through which a transport plugin interacts with the rest of
  * the application.
@@ -25,17 +22,7 @@ public interface PluginCallback {
 	TransportProperties getLocalProperties();
 
 	/**
-	 * Returns the plugin's remote transport properties.
-	 */
-	Map<ContactId, TransportProperties> getRemoteProperties();
-
-	/**
-	 * Returns the plugin's remote transport properties for the given contact.
-	 */
-	TransportProperties getRemoteProperties(ContactId c);
-
-	/**
-	 * Merges the given settings with the namespaced settings
+	 * Merges the given settings with the plugin's settings
 	 */
 	void mergeSettings(Settings s);
 
@@ -45,34 +32,12 @@ public interface PluginCallback {
 	void mergeLocalProperties(TransportProperties p);
 
 	/**
-	 * Presents the user with a choice among two or more named options and
-	 * returns the user's response. The message may consist of a translatable
-	 * format string and arguments.
-	 *
-	 * @return an index into the array of options indicating the user's choice,
-	 * or -1 if the user cancelled the choice.
-	 */
-	int showChoice(String[] options, String... message);
-
-	/**
-	 * Asks the user to confirm an action and returns the user's response. The
-	 * message may consist of a translatable format string and arguments.
-	 */
-	boolean showConfirmationMessage(String... message);
-
-	/**
-	 * Shows a message to the user. The message may consist of a translatable
-	 * format string and arguments.
-	 */
-	void showMessage(String... message);
-
-	/**
-	 * Signal that the transport got enabled.
+	 * Signals that the transport is enabled.
 	 */
 	void transportEnabled();
 
 	/**
-	 * Signal that the transport got disabled.
+	 * Signals that the transport is disabled.
 	 */
 	void transportDisabled();
 }

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/TransportConnectionWriter.java

@@ -22,11 +22,6 @@ public interface TransportConnectionWriter {
 	 */
 	int getMaxIdleTime();
 
-	/**
-	 * Returns the capacity of the transport connection in bytes.
-	 */
-	long getCapacity();
-
 	/**
 	 * Returns an output stream for writing to the transport connection.
 	 */

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/duplex/AbstractDuplexTransportConnection.java

@@ -71,11 +71,6 @@ public abstract class AbstractDuplexTransportConnection
 			return plugin.getMaxIdleTime();
 		}
 
-		@Override
-		public long getCapacity() {
-			return Long.MAX_VALUE;
-		}
-
 		@Override
 		public OutputStream getOutputStream() throws IOException {
 			return AbstractDuplexTransportConnection.this.getOutputStream();

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/duplex/DuplexPlugin.java

@@ -1,10 +1,10 @@
 package org.briarproject.bramble.api.plugin.duplex;
 
-import org.briarproject.bramble.api.contact.ContactId;
 import org.briarproject.bramble.api.data.BdfList;
 import org.briarproject.bramble.api.keyagreement.KeyAgreementListener;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import org.briarproject.bramble.api.plugin.Plugin;
+import org.briarproject.bramble.api.properties.TransportProperties;
 
 import javax.annotation.Nullable;
 
@@ -15,12 +15,11 @@ import javax.annotation.Nullable;
 public interface DuplexPlugin extends Plugin {
 
 	/**
-	 * Attempts to create and return a connection to the given contact using
-	 * the current transport and configuration properties. Returns null if a
-	 * connection cannot be created.
+	 * Attempts to create and return a connection using the given transport
+	 * properties. Returns null if a connection cannot be created.
 	 */
 	@Nullable
-	DuplexTransportConnection createConnection(ContactId c);
+	DuplexTransportConnection createConnection(TransportProperties p);
 
 	/**
 	 * Returns true if the plugin supports short-range key agreement.

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/duplex/DuplexPluginCallback.java

@@ -5,7 +5,8 @@ import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import org.briarproject.bramble.api.plugin.PluginCallback;
 
 /**
- * An interface for handling connections created by a duplex transport plugin.
+ * An interface through which a duplex plugin interacts with the rest of the
+ * application.
  */
 @NotNullByDefault
 public interface DuplexPluginCallback extends PluginCallback {

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/simplex/SimplexPlugin.java

@@ -1,10 +1,10 @@
 package org.briarproject.bramble.api.plugin.simplex;
 
-import org.briarproject.bramble.api.contact.ContactId;
 import org.briarproject.bramble.api.nullsafety.NotNullByDefault;
 import org.briarproject.bramble.api.plugin.Plugin;
 import org.briarproject.bramble.api.plugin.TransportConnectionReader;
 import org.briarproject.bramble.api.plugin.TransportConnectionWriter;
+import org.briarproject.bramble.api.properties.TransportProperties;
 
 import javax.annotation.Nullable;
 
@@ -15,18 +15,16 @@ import javax.annotation.Nullable;
 public interface SimplexPlugin extends Plugin {
 
 	/**
-	 * Attempts to create and return a reader for the given contact using the
-	 * current transport and configuration properties. Returns null if a reader
-	 * cannot be created.
+	 * Attempts to create and return a reader for the given transport
+	 * properties. Returns null if a reader cannot be created.
 	 */
 	@Nullable
-	TransportConnectionReader createReader(ContactId c);
+	TransportConnectionReader createReader(TransportProperties p);
 
 	/**
-	 * Attempts to create and return a writer for the given contact using the
-	 * current transport and configuration properties. Returns null if a writer
-	 * cannot be created.
+	 * Attempts to create and return a writer for the given transport
+	 * properties. Returns null if a writer cannot be created.
 	 */
 	@Nullable
-	TransportConnectionWriter createWriter(ContactId c);
+	TransportConnectionWriter createWriter(TransportProperties p);
 }

bramble-api/src/main/java/org/briarproject/bramble/api/plugin/simplex/SimplexPluginCallback.java

@@ -7,8 +7,8 @@ import org.briarproject.bramble.api.plugin.TransportConnectionReader;
 import org.briarproject.bramble.api.plugin.TransportConnectionWriter;
 
 /**
- * An interface for handling readers and writers created by a simplex transport
- * plugin.
+ * An interface through which a simplex plugin interacts with the rest of the
+ * application.
  */
 @NotNullByDefault
 public interface SimplexPluginCallback extends PluginCallback {

bramble-api/src/main/java/org/briarproject/bramble/api/ui/UiCallback.java

@@ -1,26 +0,0 @@
-package org.briarproject.bramble.api.ui;
-
-public interface UiCallback {
-
-	/**
-	 * Presents the user with a choice among two or more named options and
-	 * returns the user's response. The message may consist of a translatable
-	 * format string and arguments.
-	 *
-	 * @return an index into the array of options indicating the user's choice,
-	 * or -1 if the user cancelled the choice.
-	 */
-	int showChoice(String[] options, String... message);
-
-	/**
-	 * Asks the user to confirm an action and returns the user's response. The
-	 * message may consist of a translatable format string and arguments.
-	 */
-	boolean showConfirmationMessage(String... message);
-
-	/**
-	 * Shows a message to the user. The message may consist of a translatable
-	 * format string and arguments.
-	 */
-	void showMessage(String... message);
-}

bramble-api/src/main/java/org/briarproject/bramble/util/OsUtils.java

@@ -22,19 +22,6 @@ public class OsUtils {
 		return os != null && os.contains("Mac OS");
 	}
 
-	public static boolean isMacLeopardOrNewer() {
-		if (!isMac() || version == null) return false;
-		try {
-			String[] v = version.split("\\.");
-			if (v.length != 3) return false;
-			int major = Integer.parseInt(v[0]);
-			int minor = Integer.parseInt(v[1]);
-			return major >= 10 && minor >= 5;
-		} catch (NumberFormatException e) {
-			return false;
-		}
-	}
-
 	public static boolean isLinux() {
 		return os != null && os.contains("Linux") && !isAndroid();
 	}