// SPDX-FileCopyrightText: 2021 Paul Schaub <vanitasvitae@fsfe.org>
//
// SPDX-License-Identifier: Apache-2.0

package org.pgpainless.decryption_verification.cleartext_signatures;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;

import org.pgpainless.decryption_verification.ConsumerOptions;

/**
 * Interface defining the API for verification of cleartext signed documents.
 */
public interface VerifyCleartextSignatures {

    /**
     * Provide the {@link InputStream} which contains the cleartext-signed message.
     * @param inputStream inputstream
     * @return api handle
     */
    WithStrategy onInputStream(InputStream inputStream);

    interface WithStrategy {

        /**
         * Provide a {@link MultiPassStrategy} which is used to store the message content.
         * Since cleartext-signed messages cannot be processed in one pass, the message has to be passed twice.
         * Therefore the user needs to decide upon a strategy where to cache/store the message between the passes.
         * This could be {@link MultiPassStrategy#writeMessageToFile(File)} or {@link MultiPassStrategy#keepMessageInMemory()},
         * depending on message size and use-case.
         *
         * @param multiPassStrategy strategy
         * @return api handle
         */
        VerifyWith withStrategy(MultiPassStrategy multiPassStrategy);

    }

    interface VerifyWith {

        /**
         * Pass in consumer options like verification certificates, acceptable date ranges etc.
         *
         * @param options options
         * @return processor
         * @throws IOException in case of an IO error
         */
        CleartextSignatureProcessor withOptions(ConsumerOptions options) throws IOException;

    }
}