Package org.cryptomator.cryptofs

Class CryptoFileSystemProperties

java.lang.Object

java.util.AbstractMap<String,Object>

org.cryptomator.cryptofs.CryptoFileSystemProperties

All Implemented Interfaces:

Map<String,Object>

public class CryptoFileSystemProperties
extends AbstractMap<String,Object>

Properties to pass to

• FileSystems.newFileSystem(URI, Map) or
• CryptoFileSystemProvider.newFileSystem(Path, CryptoFileSystemProperties).

Author:

Markus Kreusch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CryptoFileSystemProperties.Builder	Builds CryptoFileSystemProperties
static class	CryptoFileSystemProperties.FileSystemFlags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROPERTY_FILESYSTEM_FLAGS	Key identifying the filesystem flags.
static String	PROPERTY_MASTERKEY_FILENAME	Key identifying the name of the masterkey file located inside the vault directory.
static String	PROPERTY_PASSPHRASE	Key identifying the passphrase for an encrypted vault.
static String	PROPERTY_PEPPER	Key identifying the pepper used during key derivation.

Method Summary

Modifier and Type	Method	Description
static CryptoFileSystemProperties.Builder	cryptoFileSystemProperties()	Starts construction of CryptoFileSystemProperties
static CryptoFileSystemProperties.Builder	cryptoFileSystemPropertiesFrom(Map<String,?> properties)	Starts construction of CryptoFileSystemProperties
Set<Map.Entry<String,Object>>	entrySet()
Set<CryptoFileSystemProperties.FileSystemFlags>	flags()
boolean	readonly()
static CryptoFileSystemProperties.Builder	withPassphrase(CharSequence passphrase)	Starts construction of CryptoFileSystemProperties.
static CryptoFileSystemProperties	wrap(Map<String,?> properties)	Constructs CryptoFileSystemProperties from a Map.

Methods inherited from class java.util.AbstractMap

clear, clone, containsKey, containsValue, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

PROPERTY_PASSPHRASE

public static final String PROPERTY_PASSPHRASE

Key identifying the passphrase for an encrypted vault.

See Also:

Constant Field Values

PROPERTY_PEPPER

public static final String PROPERTY_PEPPER

Key identifying the pepper used during key derivation.

Since:

1.3.2

See Also:

Constant Field Values

PROPERTY_MASTERKEY_FILENAME

public static final String PROPERTY_MASTERKEY_FILENAME

Key identifying the name of the masterkey file located inside the vault directory.

Since:

1.1.0

See Also:

Constant Field Values

PROPERTY_FILESYSTEM_FLAGS

public static final String PROPERTY_FILESYSTEM_FLAGS

Key identifying the filesystem flags.

Since:

1.3.0

See Also:

Constant Field Values

Method Detail

flags

public Set<CryptoFileSystemProperties.FileSystemFlags> flags()

readonly

public boolean readonly()

entrySet

public Set<Map.Entry<String,Object>> entrySet()

Specified by:

entrySet in interface Map<String,Object>

Specified by:

entrySet in class AbstractMap<String,Object>

cryptoFileSystemProperties

public static CryptoFileSystemProperties.Builder cryptoFileSystemProperties()

Starts construction of CryptoFileSystemProperties

Returns:

a CryptoFileSystemProperties.Builder which can be used to construct CryptoFileSystemProperties

withPassphrase

public static CryptoFileSystemProperties.Builder withPassphrase(CharSequence passphrase)

Starts construction of CryptoFileSystemProperties. Convenience function for cryptoFileSystemProperties().withPassphrase(passphrase).

Parameters:

passphrase - the passphrase to use

Returns:

a CryptoFileSystemProperties.Builder which can be used to construct CryptoFileSystemProperties

Since:

1.4.0

cryptoFileSystemPropertiesFrom

public static CryptoFileSystemProperties.Builder cryptoFileSystemPropertiesFrom(Map<String,?> properties)

Starts construction of CryptoFileSystemProperties

Parameters:

properties - a Map containing properties used to initialize the builder

Returns:

a CryptoFileSystemProperties.Builder which can be used to construct CryptoFileSystemProperties and has been initialized with the values from properties

wrap

public static CryptoFileSystemProperties wrap(Map<String,?> properties)

Constructs CryptoFileSystemProperties from a Map.

Parameters:

properties - the Map to convert

Returns:

the passed in Map if already of type CryptoFileSystemProperties or a new CryptoFileSystemProperties instance holding the values from the Map

Throws:

IllegalArgumentException - if a value in the Map does not have the expected type or if a required value is missing