-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
19 changed files
with
602 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
50 changes: 50 additions & 0 deletions
50
src/main/java/org/cryptomator/integrations/mount/Mount.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| package org.cryptomator.integrations.mount; | ||
|
|
||
| import java.io.IOException; | ||
|
|
||
| /** | ||
| * Handle to control the lifecycle of a mounted file system. | ||
| * <p> | ||
| * Created by {@link MountBuilder} | ||
| */ | ||
| public interface Mount extends AutoCloseable { | ||
|
|
||
| /** | ||
| * Returns the absolute OS path, where this mount can be accessed. | ||
| * | ||
| * @return Absolute path to the mountpoint. | ||
| */ | ||
| Mountpoint getMountpoint(); | ||
|
|
||
| /** | ||
| * Unmounts the mounted Volume. | ||
| * <p> | ||
| * If possible, attempt a graceful unmount. | ||
| * | ||
| * @throws UnmountFailedException If the unmount was not successful. | ||
| * @see #unmountForced() | ||
| */ | ||
| void unmount() throws UnmountFailedException; | ||
|
|
||
| /** | ||
| * If supported, force-unmount the volume. | ||
| * | ||
| * @throws UnmountFailedException If the unmount was not successful. | ||
| * @throws UnsupportedOperationException If {@link MountCapability#UNMOUNT_FORCED} is not supported | ||
| */ | ||
| default void unmountForced() throws UnmountFailedException { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Unmounts (if required) and releases any resources. | ||
| * | ||
| * @throws UnmountFailedException Thrown if unmounting failed | ||
| * @throws IOException Thrown if cleaning up resources failed | ||
| */ | ||
| default void close() throws UnmountFailedException, IOException { | ||
| unmount(); | ||
| } | ||
|
|
||
|
|
||
| } |
128 changes: 128 additions & 0 deletions
128
src/main/java/org/cryptomator/integrations/mount/MountBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package org.cryptomator.integrations.mount; | ||
|
|
||
| import org.jetbrains.annotations.Contract; | ||
| import org.jetbrains.annotations.Range; | ||
|
|
||
| import java.nio.file.Path; | ||
|
|
||
| /** | ||
| * 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 { | ||
|
|
||
| /** | ||
| * Sets the file system name. | ||
| * | ||
| * @param fileSystemName file system name | ||
| * @return <code>this</code> | ||
| * @throws UnsupportedOperationException If {@link MountCapability#FILE_SYSTEM_NAME} is not supported | ||
| */ | ||
| @Contract("_ -> this") | ||
| default MountBuilder setFileSystemName(String fileSystemName) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Use the given host name as the loopback address. | ||
| * | ||
| * @param hostName string conforming with the uri host part | ||
| * @return <code>this</code> | ||
| * @throws UnsupportedOperationException If {@link MountCapability#LOOPBACK_HOST_NAME} is not supported | ||
| */ | ||
| @Contract("_ -> this") | ||
| default MountBuilder setLoopbackHostName(String hostName) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Use the given TCP port of the loopback address. | ||
| * | ||
| * @param port Fixed TCP port or 0 to use a system-assigned port | ||
| * @return <code>this</code> | ||
| * @throws UnsupportedOperationException If {@link MountCapability#LOOPBACK_PORT} is not supported | ||
| */ | ||
| @Contract("_ -> this") | ||
| default MountBuilder setLoopbackPort(@Range(from = 0, to = Short.MAX_VALUE) int port) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the mount point. | ||
| * <p> | ||
| * Unless the mount service provider supports {@link MountCapability#MOUNT_TO_SYSTEM_CHOSEN_PATH}, setting a mount point is required. | ||
| * | ||
| * @param mountPoint Where to mount the volume | ||
| * @return <code>this</code> | ||
| */ | ||
| @Contract("_ -> this") | ||
| default MountBuilder setMountpoint(Path mountPoint) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Sets mount flags. | ||
| * | ||
| * @param mountFlags Mount flags | ||
| * @return <code>this</code> | ||
| * @throws UnsupportedOperationException If {@link MountCapability#MOUNT_FLAGS} is not supported | ||
| * @see MountService#getDefaultMountFlags() | ||
| */ | ||
| @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 MountCapability#READ_ONLY} is not supported | ||
| */ | ||
| @Contract("_ -> this") | ||
| default MountBuilder setReadOnly(boolean mountReadOnly) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Sets a unique volume id. | ||
| * <p> | ||
| * The volume id is used as a path component, thus must conform with the os-dependent path component restrictions. | ||
| * | ||
| * @param volumeId String conforming with the os-dependent path component restrictions | ||
| * @return <code>this</code> | ||
| * @throws UnsupportedOperationException If {@link MountCapability#VOLUME_ID} is not supported | ||
| */ | ||
| @Contract("_ -> this") | ||
| default MountBuilder setVolumeId(String volumeId) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Sets a volume name. | ||
| * <p> | ||
| * The volume name is intended to be human-readable. The input string might be altered to replace non-conforming characters and thus is not suited to identify the volume. | ||
| * | ||
| * @param volumeName String conforming with the os-dependent naming restrictions | ||
| * @return <code>this</code> | ||
| * @throws UnsupportedOperationException If {@link MountCapability#VOLUME_NAME} is not supported | ||
| */ | ||
| @Contract("_ -> this") | ||
| default MountBuilder setVolumeName(String volumeName) { | ||
| throw new UnsupportedOperationException(); | ||
| } | ||
|
|
||
| /** | ||
| * Mounts the file system. | ||
| * | ||
| * @return A mount handle | ||
| * @throws MountFailedException If mounting failed | ||
| */ | ||
| @Contract(" -> new") | ||
| Mount mount() throws MountFailedException; | ||
|
|
||
| } |
Oops, something went wrong.