Package de.adorsys.keymanagement.api.keystore

Interface KeyStoreView

public interface KeyStoreView
KeyStore view from different angles. IMPORTANT: each opened view (i.e. entries() or metadata()) is independent, so while it will propagate changes done through it into keystore, it will not see changes done from another view.

  • Method Summary

    Modifier and Type
    Method
    Description
    <Q> AliasView<Q>
    aliases()
    Returns keystore entries EXCLUDING metadata entries.
    <Q> AliasView<Q>
    allAliases()
    Returns all keystore entries including metadata entries.
    <Q> EntryView<Q>
    allEntries()
    Returns all keystore entries including metadata entries.
    KeySet
    copyToKeySet(Function<String,char[]> keyPassword)
    Clones current KeySource into KeySet in a way, that all keys will be materialized in KeySet.
    KeySetTemplate
    copyToTemplate(Function<String,char[]> keyPassword)
    Clones current KeySource into KeySetTemplate in a way, that all keys will be materialized in KeySetTemplate.
    <Q> EntryView<Q>
    entries()
    Returns keystore entries EXCLUDING metadata entries.
    KeySource
    source()
    Get source of keys.

  • Method Details

    • entries

      <Q> EntryView<Q> entries()
      Returns keystore entries EXCLUDING metadata entries.

    • aliases

      <Q> AliasView<Q> aliases()
      Returns keystore entries EXCLUDING metadata entries.

    • allEntries

      <Q> EntryView<Q> allEntries()
      Returns all keystore entries including metadata entries.

    • allAliases

      <Q> AliasView<Q> allAliases()
      Returns all keystore entries including metadata entries.

    • source

      KeySource source()
      Get source of keys. For example KeySource can wrap following entities - java Keystore, Database table, list of Key instances, etc.
      Returns:
      object which have access to keys and can operate with them

    • copyToKeySet

      KeySet copyToKeySet(Function<String,char[]> keyPassword)
      Clones current KeySource into KeySet in a way, that all keys will be materialized in KeySet. You can view it as generates keySet from all existing in key source keys
      Parameters:
      keyPassword - password which is used to access keys
      Returns:
      keySet with lists of key pairs, secret keys or key entries

    • copyToTemplate

      KeySetTemplate copyToTemplate(Function<String,char[]> keyPassword)
      Clones current KeySource into KeySetTemplate in a way, that all keys will be materialized in KeySetTemplate. You can view it as generating template from all existing in key source keys
      Parameters:
      keyPassword - password which is used to access keys
      Returns:
      key set template with lists of key pairs, secret keys or key entries