at.favre.lib.armadillo

Interface OnSecurePreferenceChangeListener

public interface OnSecurePreferenceChangeListener

Allow to register preference change listeners that receive a OnSecurePreferenceChangeListener.DerivedKeyComparison instance in order to make it possible compare the changed key against actual key constants (instead of the derivedKeys that the library uses)

Example:

     public class SampleActivity extends AppCompatActivity {
         private final String KEY_TOKEN = "token";
         private final OnSecurePreferenceChangeListener onSecurePreferenceChangeListener = (sharedPreferences, comparison) -> {
             if (comparison.isDerivedKeyEqualTo(KEY_TOKEN)) {

                 String newToken = sharedPreferences.getString(KEY_TOKEN, null);
                 onTokenUpdated(newToken);
             }
         };

         private void onTokenUpdated(String newToken) {
             // Do whatever is required when underlying token has been updated
         }

         @Overrides
         protected void onCreate(Bundle savedInstanceState) {
             super.onCreate(savedInstanceState);
             // ... initialize encrypted preferences ...
             encryptedPreferences.registerOnSecurePreferenceChangeListener(onSecurePreferenceChangeListener);
         }
    }
 

Since:

0.9.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	OnSecurePreferenceChangeListener.DerivedKeyComparison Allows client side OnSecurePreferenceChangeListener to check if the changed key is the key of interest.

Method Summary

Modifier and Type

Method and Description

void

onSecurePreferenceChanged(android.content.SharedPreferences sharedPreferences, OnSecurePreferenceChangeListener.DerivedKeyComparison comparison) Variation of the regular SharedPreferences.OnSharedPreferenceChangeListener.onSharedPreferenceChanged(SharedPreferences, String) that provides a OnSecurePreferenceChangeListener.DerivedKeyComparison to allow client side react only to a specific changed key

Method Detail

onSecurePreferenceChanged

void onSecurePreferenceChanged(android.content.SharedPreferences sharedPreferences,
                               OnSecurePreferenceChangeListener.DerivedKeyComparison comparison)

Variation of the regular SharedPreferences.OnSharedPreferenceChangeListener.onSharedPreferenceChanged(SharedPreferences, String) that provides a OnSecurePreferenceChangeListener.DerivedKeyComparison to allow client side react only to a specific changed key

Parameters:

sharedPreferences - the shared preferences instance

comparison - utility to check equivalence between plain keys and derived keys