/*
 * 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.nifi.processors.cipher.age;

import java.io.IOException;
import java.io.InputStream;
import java.util.List;

/**
 * Abstraction for reading public or private keys encoded using Bech32 supporting age-encryption.org
 *
 * @param <T> Key Type
 */
public interface AgeKeyReader<T> {
    /**
     * Read Input Stream and return collection of parsed objects corresponding to parsed keys
     *
     * @param inputStream Input Stream to be parsed
     * @return Collection of parsed objects
     * @throws IOException Thrown on failure to read Input Stream
     */
    List<T> read(InputStream inputStream) throws IOException;
}
