Module org.cryptomator.cryptofs

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 enum	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 final String	PROPERTY_CIPHER_COMBO	Key identifying the combination of ciphers to use in a vault.
static final String	PROPERTY_FILESYSTEM_FLAGS	Key identifying the filesystem flags.
static final String	PROPERTY_KEYLOADER	Key identifying the key loader used during initialization.
static final String	PROPERTY_MASTERKEY_FILENAME	Deprecated. Replaced with external keyloader API
static final String	PROPERTY_MAX_CLEARTEXT_NAME_LENGTH	Maximum cleartext filename length.
static final String	PROPERTY_SHORTENING_THRESHOLD	Shortening threshold for ciphertext filenames.
static final String	PROPERTY_VAULTCONFIG_FILENAME	Key identifying the name of the vault config file located inside the vault directory.

Method Summary

Modifier and Type	Method	Description
org.cryptomator.cryptolib.api.CryptorProvider.Scheme	cipherCombo()
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	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 Details

PROPERTY_MAX_CLEARTEXT_NAME_LENGTH

public static final String PROPERTY_MAX_CLEARTEXT_NAME_LENGTH

Maximum cleartext filename length.

Since:

2.0.0

See Also:

• Constant Field Values

PROPERTY_SHORTENING_THRESHOLD

public static final String PROPERTY_SHORTENING_THRESHOLD

Shortening threshold for ciphertext filenames.

Since:

2.5.0

See Also:

• Constant Field Values

PROPERTY_KEYLOADER

public static final String PROPERTY_KEYLOADER

Key identifying the key loader used during initialization.

Since:

2.0.0

See Also:

• Constant Field Values

PROPERTY_VAULTCONFIG_FILENAME

public static final String PROPERTY_VAULTCONFIG_FILENAME

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

Since:

2.0.0

See Also:

• Constant Field Values

PROPERTY_MASTERKEY_FILENAME

@Deprecated
public static final String PROPERTY_MASTERKEY_FILENAME

Deprecated.

Replaced with external keyloader API

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

PROPERTY_CIPHER_COMBO

public static final String PROPERTY_CIPHER_COMBO

Key identifying the combination of ciphers to use in a vault. Only meaningful during vault initialization.

Since:

2.0.0

See Also:

• Constant Field Values

Method Details

cipherCombo

public org.cryptomator.cryptolib.api.CryptorProvider.Scheme cipherCombo()

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

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