Package org.apache.pulsar.client.api

Interface CryptoKeyReader

  • All Superinterfaces:
    java.io.Serializable
    @Public
@Stable
public interface CryptoKeyReader
extends java.io.Serializable
    Interface that abstracts the access to a key store.

    • Method Detail

      • getPublicKey

        EncryptionKeyInfo getPublicKey​(java.lang.String keyName,
                               java.util.Map<java.lang.String,​java.lang.String> metadata)
        Return the encryption key corresponding to the key name in the argument.

        This method should be implemented to return the EncryptionKeyInfo. This method will be called at the time of producer creation as well as consumer receiving messages. Hence, application should not make any blocking calls within the implementation.

        Parameters:
        keyName - Unique name to identify the key
        metadata - Additional information needed to identify the key
        Returns:
        EncryptionKeyInfo with details about the public key

      • getPrivateKey

        EncryptionKeyInfo getPrivateKey​(java.lang.String keyName,
                                java.util.Map<java.lang.String,​java.lang.String> metadata)
        Parameters:
        keyName - Unique name to identify the key
        metadata - Additional information needed to identify the key
        Returns:
        byte array of the private key value