at.favre.lib.armadillo

Interface RecoveryPolicy

All Known Implementing Classes:

SimpleRecoveryPolicy, SimpleRecoveryPolicy.Default

public interface RecoveryPolicy

Defines how the storage should behave on errors while decrypting.

For a simpler version check out SimpleRecoveryPolicy, this is for more advanced use cases.

Method Summary

Modifier and Type	Method and Description
void	handleBrokenContent(EncryptionProtocolException e, java.lang.String keyHash, java.lang.String base64Encrypted, boolean userPasswordUsed, ArmadilloSharedPreferences sharedPreferences) When a value cannot be decrypted, this method will be called

Method Detail

handleBrokenContent

void handleBrokenContent(EncryptionProtocolException e,
                         java.lang.String keyHash,
                         java.lang.String base64Encrypted,
                         boolean userPasswordUsed,
                         ArmadilloSharedPreferences sharedPreferences)
                  throws SecureSharedPreferenceCryptoException

When a value cannot be decrypted, this method will be called

Parameters:

e - thrown exception

keyHash - hash of the key that was called

base64Encrypted - encrypted data in base64 encoding

userPasswordUsed - if a user password was used to decrypt the storage

sharedPreferences - currently used shared preference (be aware if you modify)

Throws:

SecureSharedPreferenceCryptoException - if you want to throw an exception, use or wrap in this typ