org.apache.pulsar.client.api.CryptoKeyReader Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.pulsar.client.api;
import java.io.Serializable;
import java.util.Map;
import org.apache.pulsar.common.classification.InterfaceAudience;
import org.apache.pulsar.common.classification.InterfaceStability;
/**
* Interface that abstracts the access to a key store.
*/
@InterfaceAudience.Public
@InterfaceStability.Stable
public interface CryptoKeyReader extends Serializable {
/**
* 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.
*
* @param keyName
* Unique name to identify the key
* @param metadata
* Additional information needed to identify the key
* @return EncryptionKeyInfo with details about the public key
*/
EncryptionKeyInfo getPublicKey(String keyName, Map metadata);
/**
* @param keyName
* Unique name to identify the key
* @param metadata
* Additional information needed to identify the key
* @return byte array of the private key value
*/
EncryptionKeyInfo getPrivateKey(String keyName, Map metadata);
}