/*
 * DSS - Digital Signature Services
 *
 * Copyright (C) 2013 European Commission, Directorate-General Internal Market and Services (DG MARKT), B-1049 Bruxelles/Brussel
 *
 * Developed by: 2013 ARHS Developments S.A. (rue Nicolas Bové 2B, L-1253 Luxembourg) http://www.arhs-developments.com
 *
 * This file is part of the "DSS - Digital Signature Services" project.
 *
 * "DSS - Digital Signature Services" is free software: you can redistribute it and/or modify it under the terms of
 * the GNU Lesser General Public License as published by the Free Software Foundation, either version 2.1 of the
 * License, or (at your option) any later version.
 *
 * DSS 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License along with
 * "DSS - Digital Signature Services".  If not, see <http://www.gnu.org/licenses/>.
 */

package eu.europa.ec.markt.dss.validation102853.tsp;

import java.io.Serializable;

import org.bouncycastle.tsp.TimeStampToken;

import eu.europa.ec.markt.dss.DigestAlgorithm;
import eu.europa.ec.markt.dss.exception.DSSException;

/**
 * Abstraction of a Time Stamping authority which delivers RFC 3161 Time Stamp Responses containing tokens, from Time
 * Stamp Requests.
 *
 * @version $Revision$ - $Date$
 */

public interface TSPSource extends Serializable {

	/**
	 * Gets a TimeStampResponse relevant to the provided digest value.
	 *
	 * @param digestAlgorithm {@code DigestAlgorithm} used to generate the message imprint
	 * @param digest          digest value as byte array
	 * @return {@code TimeStampToken}
	 * @throws DSSException
	 */
	public TimeStampToken getTimeStampResponse(final DigestAlgorithm digestAlgorithm, final byte[] digest) throws DSSException;

	/**
	 * Set the request policy OID.
	 *
	 * @param reqPolicyOid {@code String} representing the requested policy OID
	 */
	public void setReqPolicyOid(final String reqPolicyOid);

	/**
	 * @param digestValue array of bytes to be digested
	 * @return this method returns the unique id associated with the timestamp. It's a MD5 of {@code digestValue} and nonce
	 */
	public String getUniqueId(byte[] digestValue);
}