/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package com.sun.jarsigner;

import java.net.URI;

import java.security.cert.X509Certificate;

import java.util.zip.ZipFile;

/**

 * This interface encapsulates the parameters for a ContentSigner object.

 *

 * @since 1.5

 * @author Vincent Ryan

 */

@jdk.Exported

public interface ContentSignerParameters {

    /**

     * Retrieves the command-line arguments passed to the jarsigner tool.

     *

     * @return The command-line arguments. May be null.

     */

    public String[] getCommandLine();

    /**

     * Retrieves the identifier for a Timestamping Authority (TSA).

     *

     * @return The TSA identifier. May be null.

     */

    public URI getTimestampingAuthority();

    /**

     * Retrieves the certificate for a Timestamping Authority (TSA).

     *

     * @return The TSA certificate. May be null.

     */

    public X509Certificate getTimestampingAuthorityCertificate();

    /**

     * Retrieves the TSAPolicyID for a Timestamping Authority (TSA).

     *

     * @return The TSAPolicyID. May be null.

     */

    public default String getTSAPolicyID() {

        return null;

    }

    /**

     * Retreives the message digest algorithm that is used to generate

     * the message imprint to be sent to the TSA server.

     *

     * @since 1.9

     * @return The non-null string of the message digest algorithm name.

     */

    public default String getTSADigestAlg() {

        return "SHA-256";

    }

    /**

     * Retrieves the JAR file's signature.

     *

     * @return The non-null array of signature bytes.

     */

    public byte[] getSignature();

    /**

     * Retrieves the name of the signature algorithm.

     *

     * @return The non-null string name of the signature algorithm.

     */

    public String getSignatureAlgorithm();

    /**

     * Retrieves the signer's X.509 certificate chain.

     *

     * @return The non-null array of X.509 public-key certificates.

     */

    public X509Certificate[] getSignerCertificateChain();

    /**

     * Retrieves the content that was signed.

     * The content is the JAR file's signature file.

     *

     * @return The content bytes. May be null.

     */

    public byte[] getContent();

    /**

     * Retrieves the original source ZIP file before it was signed.

     *

     * @return The original ZIP file. May be null.

     */

    public ZipFile getSource();

}