Package com.isode.dsapi.profile

Interface BindProfileList.ISettingsEncrypter

All Known Implementing Classes:
MConsoleEncrypter, MLCEncrypter
Enclosing class:
BindProfileList
protected static interface BindProfileList.ISettingsEncrypter
Applications which want to encrypt arbitrary data in "multisetting" or "setting" parameters using the BPL passphrase must implement this interface, which will be used when the BPL is loaded/stored.
Since:
15.2

  • Method Details

    • attributeReadFromFile

      List<BindProfileList.StringSection> attributeReadFromFile(String key, String value)
      An individual key/value pair has been read from an AttributeBlock in the BPL and is offered in case the value needs decrypting.
      Parameters:
      key - the name of the key which will not be null
      value - the value which will not be null
      Returns:
      a list of StringSections that need decrypting. This may be null, or an empty list, in which case no decryption will be performed
      Since:
      16.6

    • settingReadFromFile

      List<BindProfileList.StringSection> settingReadFromFile(String settingKey, String value)
      A "setting" has been read from the BPL, and is offered in case there's anything in there that needs decrypting
      Parameters:
      settingKey - the name of the key, will not be null
      value - the value, will not be null.
      Returns:
      a list of StringSections that need decrypting. This may be null, or an empty list, in which case no decryption will be performed

    • multiSettingReadFromFile

      List<BindProfileList.StringSection> multiSettingReadFromFile(String multiSettingKey, String value)
      A "multisetting" has been read from the BPL, and is offered in case there's anything in there that needs decrypting
      Parameters:
      multiSettingKey - the name of the key, will not be null.
      value - the value, will not be null.
      Returns:
      a list of StringSections that need decrypting. This may be null, or an empty list, in which case no decryption will be performed

    • settingToBeWritten

      List<BindProfileList.StringSection> settingToBeWritten(String settingKey, String value)
      A "setting" is about to be written to BPL, and is offered in case there's anything in there that needs encrypting.
      Parameters:
      settingKey - the name of the key, will not be null
      value - the value, will not be null.
      Returns:
      a list of StringSections that need encrypting. This may be null, or an empty list, in which case no encryption will be performed

    • multiSettingToBeWritten

      List<BindProfileList.StringSection> multiSettingToBeWritten(String multiSettingKey, String value)
      A "multisetting" is about to be written to BPL, and is offered in case there's anything in there that needs encrypting.
      Parameters:
      multiSettingKey - the name of the key, will not be null
      value - the value, will not be null.
      Returns:
      a list of StringSections that need encrypting. This may be null, or an empty list, in which case no encryption will be performed

    • attributeToBeWritten

      List<BindProfileList.StringSection> attributeToBeWritten(String key, String value)
      A key/value pair is about to be written to a BPL wihtin an AttributeBlock, and is offered in case the value needs encrypting.
      Parameters:
      key - the name of the key, will not be null
      value - the value, will not be null.
      Returns:
      a list of StringSections that need encrypting. This may be null, or an empty list, in which case no encryption will be performed
      Since:
      16.6