Interface KeyProvider

All Known Implementing Classes:
KeyStoreKeyProvider, MockAesKeyProvider

@Public public interface KeyProvider
KeyProvider is a interface to abstract the different methods of retrieving key material from key storage such as Java key store.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
     
    static final String
     
  • Method Summary

    Modifier and Type
    Method
    Description
    getKey(String alias)
    Retrieve the key for a given key aliase
    Key[]
    getKeys(String[] aliases)
    Retrieve keys for a given set of key aliases
    void
    init(String params)
    Initialize the key provider
  • Field Details

  • Method Details

    • init

      void init(String params)
      Initialize the key provider
    • getKey

      Key getKey(String alias)
      Retrieve the key for a given key aliase
      Returns:
      the keys corresponding to the supplied alias, or null if a key is not found
    • getKeys

      Key[] getKeys(String[] aliases)
      Retrieve keys for a given set of key aliases
      Parameters:
      aliases - an array of aliases
      Returns:
      an array of keys corresponding to the supplied aliases, an entry will be null if a key is not found