Package org.gridgain.internal.encryption.storage

Class KeyChain

java.lang.Object
org.gridgain.internal.encryption.storage.KeyChain
public class KeyChain extends Object
Data encryption key chain.

  • Constructor Summary

    Constructors
    Constructor
    Description
    KeyChain(int activeKeyId, Collection<org.gridgain.internal.encryption.provider.DataEncryptionKey> keys, @Nullable String providerName)
    Constructor.
    KeyChain(org.gridgain.internal.encryption.provider.DataEncryptionKey key, @Nullable String providerName)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.gridgain.internal.encryption.provider.DataEncryptionKey
    activeKey()
    Returns active data encryption key.
    void
    addKey(org.gridgain.internal.encryption.provider.DataEncryptionKey key)
    Adds new data encryption key to chain.
    boolean
    changeActiveKey(int keyId)
    Changes active data encryption key to provided one.
    org.gridgain.internal.encryption.provider.DataEncryptionKey
    getKey(int keyId)
    Returns data encryption key for provided key identifier.
    Collection<org.gridgain.internal.encryption.provider.DataEncryptionKey>
    keys()
     
    @Nullable String
    providerName()
    Returns encryption provider name.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • KeyChain

      public KeyChain(org.gridgain.internal.encryption.provider.DataEncryptionKey key, @Nullable @Nullable String providerName)
      Constructor.
      Parameters:
      key - Data encryption key.
      providerName - Encryption provider name.

    • KeyChain

      public KeyChain(int activeKeyId, Collection<org.gridgain.internal.encryption.provider.DataEncryptionKey> keys, @Nullable @Nullable String providerName)
      Constructor.
      Parameters:
      activeKeyId - Identifier of active data encryption key. Must be presented in keys parameter.
      keys - Data encryption keys.
      providerName - Encryption provider name.

  • Method Details

    • providerName

      @Nullable public @Nullable String providerName()
      Returns encryption provider name.

    • keys

      public Collection<org.gridgain.internal.encryption.provider.DataEncryptionKey> keys()

    • activeKey

      public org.gridgain.internal.encryption.provider.DataEncryptionKey activeKey()
      Returns active data encryption key.

    • getKey

      public org.gridgain.internal.encryption.provider.DataEncryptionKey getKey(int keyId)
      Returns data encryption key for provided key identifier.
      Parameters:
      keyId - Key identifier.

    • addKey

      public void addKey(org.gridgain.internal.encryption.provider.DataEncryptionKey key)
      Adds new data encryption key to chain.
      Parameters:
      key - Data encryption key.

    • changeActiveKey

      public boolean changeActiveKey(int keyId)
      Changes active data encryption key to provided one.
      Parameters:
      keyId - New active key identifier.
      Returns:
      true if key changed successfully, false if key with provided identifier doesn't exist in chain.