pulsar-client-kafka-compat/pulsar-client-kafka/src/main/java/org/apache/pulsar/client/kafka/compat/CryptoKeyReaderFactory.java

/**
 * 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.kafka.compat;

import java.util.Properties;
import java.util.Set;

import org.apache.pulsar.client.api.CryptoKeyReader;

/**
 * Factory class to create {@link CryptoKeyReader} by using configuration stored in Producer/Consumer properties.
 *
 */
public interface CryptoKeyReaderFactory {

    /**
     * Create CryptoKeyReader object for Producer/Consumer.
     * 
     * @param properties
     *            properties provided by user to create CryptoKeyReader based on configuration params
     * @return CryptoKeyReader
     */
    CryptoKeyReader create(Properties properties);

    /**
     * Encryption keys for {@link CryptoKeyReader} while enabling encryption at producer.
     *
     *  @param properties
     *            properties provided by user to get encryption-keys based on configuration params
     * @return Set of encryption keys
     */
    default Set<String> getEncryptionKey(Properties properties) {
        return null;
    }
}