refined API

Author: overheadhunter

src/main/java/module-info.java

@@ -1,4 +1,4 @@
-import org.cryptomator.integrations.mount.FilesystemMountProvider;
+import org.cryptomator.integrations.mount.MountProvider;
 import org.cryptomator.integrations.tray.TrayMenuController;
 import org.cryptomator.integrations.autostart.AutoStartProvider;
 import org.cryptomator.integrations.keychain.KeychainAccessProvider;
@@ -19,7 +19,7 @@
 
 	uses AutoStartProvider;
 	uses KeychainAccessProvider;
-	uses FilesystemMountProvider;
+	uses MountProvider;
 	uses TrayIntegrationProvider;
 	uses TrayMenuController;
 	uses UiAppearanceProvider;

src/main/java/org/cryptomator/integrations/mount/FileSystemMount.java

@@ -0,0 +1,45 @@
+package org.cryptomator.integrations.mount;
+
+import java.nio.file.Path;
+import java.util.function.Consumer;
+
+/**
+ * Handle to control the lifecycle of a mounted file system.
+ * <p>
+ * Created by {@link MountBuilder}
+ */
+public interface Mount extends AutoCloseable {
+
+	//TODO: either this or reveal method, not both
+	Path getAccessPoint();
+
+	//TODO: is this needed? why not just let the consumer reveal?
+	// See WebDAV: LinuxGioMounter and LinuxGvfsMounter -> no path, just a command
+	void reveal(Consumer<Path> cmd);
+
+	/**
+	 * Unmounts the mounted Volume.
+	 * <p>
+	 * If possible, attempt a graceful unmount.
+	 *
+	 * @throws UnmountFailedException If the unmount was not successful.
+	 * @see #unmountForced()
+	 */
+	void unmout() throws UnmountFailedException;
+
+	/**
+	 * If supported, force-unmount the volume.
+	 *
+	 * @throws UnmountFailedException        If the unmount was not successful.
+	 * @throws UnsupportedOperationException If {@link MountFeature#UNMOUNT_FORCED} is not supported
+	 */
+	default void unmountForced() throws UnmountFailedException {
+		throw new UnsupportedOperationException();
+	}
+
+	default void close() throws UnmountFailedException {
+		unmout();
+	}
+
+
+}

src/main/java/org/cryptomator/integrations/mount/FilesystemMountProvider.java

@@ -0,0 +1,85 @@
+package org.cryptomator.integrations.mount;
+
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.Range;
+
+import java.nio.file.Path;
+import java.util.function.Consumer;
+
+/**
+ * Builder to mount a filesystem.
+ * <p>
+ * The setter may attempt to validate the input, but {@link #mount()} may still fail due to missing or invalid (combination of) options.
+ * This holds especially for {@link MountBuilder#setMountFlags(String)};
+ */
+public interface MountBuilder {
+
+	//TODO: Idea: every setter verifies the set and can throw an IllegalArgumentException
+
+	/**
+	 * Sets the mount point.
+	 *
+	 * @param mountPoint Where to mount the volume
+	 * @return <code>this</code>
+	 * @throws UnsupportedOperationException If {@link MountFeature#MOUNT_POINT_EMPTY_DIR} is not supported // TODO: what MOUNT_POINT_* features do we really need?
+	 * @see MountProvider#getDefaultMountPoint(String)
+	 */
+	@Contract("_ -> this")
+	default MountBuilder setMountpoint(Path mountPoint) {
+		throw new UnsupportedOperationException();
+	}
+
+	// TODO: in what legacy mounter impl is this used?
+	@Contract("_ -> this")
+	default MountBuilder setOnExitAction(Consumer<Throwable> onExitAction) {
+		throw new UnsupportedOperationException();
+	}
+
+	/**
+	 * Sets mount flags.
+	 *
+	 * @param mountFlags Mount flags
+	 * @return <code>this</code>
+	 * @throws UnsupportedOperationException If {@link MountFeature#MOUNT_FLAGS} is not supported
+	 * @see MountProvider#getDefaultMountFlags(String)
+	 */
+	@Contract("_ -> this")
+	default MountBuilder setMountFlags(String mountFlags) {
+		throw new UnsupportedOperationException();
+	}
+
+	/**
+	 * Instructs the mount to be read-only.
+	 *
+	 * @param mountReadOnly Whether to mount read-only.
+	 * @return <code>this</code>
+	 * @throws UnsupportedOperationException If {@link MountFeature#READ_ONLY} is not supported
+	 */
+	@Contract("_ -> this")
+	default MountBuilder setReadOnly(boolean mountReadOnly) {
+		throw new UnsupportedOperationException();
+	}
+
+	/**
+	 * Use the given TCP port.
+	 *
+	 * @param port fixed TCP port or 0 to use a system-assigned port
+	 * @return <code>this</code>
+	 * @throws UnsupportedOperationException If {@link MountFeature#PORT} is not supported
+	 */
+	@Contract("_ -> this")
+	default MountBuilder setPort(@Range(from = 0, to = Short.MAX_VALUE) int port) {
+		throw new UnsupportedOperationException();
+	}
+
+
+	/**
+	 * Mounts the file system.
+	 *
+	 * @return A mount handle
+	 * @throws MountFailedException If mounting failed
+	 */
+	@Contract(" -> new")
+	Mount mount() throws MountFailedException;
+
+}

src/main/java/org/cryptomator/integrations/mount/Mount.java

@@ -1,13 +1,39 @@
 package org.cryptomator.integrations.mount;
 
+/**
+ * Describes what aspects of the mount implementation can or should be used.
+ * <p>
+ * This may be used to show or hide different configuration options depending on the chosen mount provider.
+ */
 public enum MountFeature {
+	/**
+	 * The provider supports {@link MountProvider#getDefaultMountFlags(String)}
+	 * and the builder requires {@link MountBuilder#setMountFlags(String)}.
+	 */
 	MOUNT_FLAGS,
 	MOUNT_POINT_EMPTY_DIR,
 	MOUNT_POINT_DRIVE_LETTER,
 	MOUNT_POINT_PATH_PREFIX,
+
+	/**
+	 * The builder supports {@link MountBuilder#setReadOnly(boolean)}
+	 */
 	READ_ONLY,
+
+	/**
+	 * The mount supports {@link Mount#unmountForced()}.
+	 */
 	UNMOUNT_FORCED,
 	ON_EXIT_ACTION,
+
+	/**
+	 * The provider supports {@link MountProvider#getDefaultPort()}
+	 * and the builder requires {@link MountBuilder#setPort(int)}.
+	 */
 	PORT,
+
+	/**
+	 * The provider supports {@link MountProvider#getDefaultMountPoint(String)}
+	 */
 	DEFAULT_MOUNT_POINT
 }