/*
 *
 * Copyright (c) 2013 - 2017 Lijun Liao
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 *
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * THE AUTHOR LIJUN LIAO. LIJUN LIAO DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the XiPKI software without
 * disclosing the source code of your own applications.
 *
 * For more information, please contact Lijun Liao at this
 * address: lijun.liao@gmail.com
 */

package org.xipki.commons.security;

import java.io.IOException;
import java.security.PrivateKey;
import java.security.PublicKey;
import java.security.cert.X509Certificate;
import java.util.Date;

import org.bouncycastle.asn1.crmf.POPOSigningKey;
import org.bouncycastle.asn1.x509.AlgorithmIdentifier;
import org.bouncycastle.cert.X509CRLHolder;
import org.bouncycastle.cert.X509CertificateHolder;
import org.bouncycastle.cert.X509v2CRLBuilder;
import org.bouncycastle.cert.X509v3CertificateBuilder;
import org.bouncycastle.cert.cmp.CMPException;
import org.bouncycastle.cert.cmp.ProtectedPKIMessage;
import org.bouncycastle.cert.cmp.ProtectedPKIMessageBuilder;
import org.bouncycastle.cert.crmf.ProofOfPossessionSigningKeyBuilder;
import org.bouncycastle.cert.ocsp.BasicOCSPResp;
import org.bouncycastle.cert.ocsp.BasicOCSPRespBuilder;
import org.bouncycastle.cert.ocsp.OCSPException;
import org.bouncycastle.cert.ocsp.OCSPReq;
import org.bouncycastle.cert.ocsp.OCSPReqBuilder;
import org.bouncycastle.pkcs.PKCS10CertificationRequest;
import org.bouncycastle.pkcs.PKCS10CertificationRequestBuilder;
import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.xipki.commons.password.PasswordResolver;
import org.xipki.commons.security.exception.NoIdleSignerException;
import org.xipki.commons.security.exception.XiSecurityException;

/**
 * @author Lijun Liao
 * @since 2.0.0
 */

public interface ConcurrentContentSigner {

    String getName();

    AlgorithmIdentifier getAlgorithmIdentifier();

    /**
     * Returns the algorithm code in XiPKI context.
     * @return algorithm code
     */
    AlgorithmCode getAlgorithmCode();

    /**
     * Get the private key.
     * @return the private key if possible. {@code null} may be returned.
     */
    PrivateKey getPrivateKey();

    void setPublicKey(@NonNull PublicKey publicKey);

    PublicKey getPublicKey();

    X509Certificate getCertificate();

    X509CertificateHolder getCertificateAsBcObject();

    void setCertificateChain(@Nullable X509Certificate[] certchain);

    X509Certificate[] getCertificateChain();

    X509CertificateHolder[] getCertificateChainAsBcObjects();

    void initialize(@Nullable String conf, @Nullable PasswordResolver passwordResolver)
            throws XiSecurityException;

    POPOSigningKey build(@NonNull ProofOfPossessionSigningKeyBuilder builder)
            throws NoIdleSignerException;

    ProtectedPKIMessage build(@NonNull ProtectedPKIMessageBuilder builder)
            throws NoIdleSignerException, CMPException;

    X509CRLHolder build(@NonNull X509v2CRLBuilder builder) throws NoIdleSignerException;

    X509CertificateHolder build(@NonNull X509v3CertificateBuilder builder)
            throws NoIdleSignerException;

    OCSPReq build(@NonNull OCSPReqBuilder builder, X509CertificateHolder[] chain)
            throws NoIdleSignerException, OCSPException;

    BasicOCSPResp build(@NonNull BasicOCSPRespBuilder builder,
            @Nullable X509CertificateHolder[] chain, @NonNull Date producedAt)
            throws NoIdleSignerException, OCSPException;

    PKCS10CertificationRequest build(@NonNull PKCS10CertificationRequestBuilder builder)
            throws NoIdleSignerException;

    byte[] sign(@NonNull byte[] data) throws NoIdleSignerException, IOException;

    boolean isHealthy();

    void shutdown();

}