Module org.cryptomator.cryptofs

Package org.cryptomator.cryptofs.health.api

Interface DiagnosticResult

All Known Implementing Classes:

CheckFailed

public interface DiagnosticResult

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DiagnosticResult.Fix
static enum	DiagnosticResult.Severity

Method Summary

Modifier and Type	Method	Description
default Map<String,String>	details()	Get more specific info about the result like names of affected resources.
default void	fix(Path pathToVault, VaultConfig config, org.cryptomator.cryptolib.api.Masterkey masterkey, org.cryptomator.cryptolib.api.Cryptor cryptor)	Deprecated. Use getFix(Path, VaultConfig, Masterkey, Cryptor) instead
default Optional<DiagnosticResult.Fix>	getFix(Path pathToVault, VaultConfig config, org.cryptomator.cryptolib.api.Masterkey masterkey, org.cryptomator.cryptolib.api.Cryptor cryptor)
DiagnosticResult.Severity	getSeverity()
String	toString()

Method Details

getSeverity

DiagnosticResult.Severity getSeverity()

toString

String toString()

Overrides:

toString in class Object

Returns:

A short, human-readable summary of the result.

fix

@Deprecated
default void fix(Path pathToVault,
 VaultConfig config,
 org.cryptomator.cryptolib.api.Masterkey masterkey,
 org.cryptomator.cryptolib.api.Cryptor cryptor)
          throws IOException

Deprecated.

Use getFix(Path, VaultConfig, Masterkey, Cryptor) instead

A fix for the result.

"Fix" does not imply to restore lost data. It only implies, that the issue leading to this result is resolved.

Parameters:

pathToVault - path to the root directory of the vault

config - the vault config

masterkey - the masterkey of the vault

cryptor -

Throws:

IOException

UnsupportedOperationException - if no fix is implemented for this result

getFix

default Optional<DiagnosticResult.Fix> getFix(Path pathToVault,
 VaultConfig config,
 org.cryptomator.cryptolib.api.Masterkey masterkey,
 org.cryptomator.cryptolib.api.Cryptor cryptor)

details

default Map<String,String> details()

Get more specific info about the result like names of affected resources.

Returns:

A map of strings containing result specific information