org.demoiselle.signer.cryptography.Digest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signer-cryptography Show documentation
Demoiselle Signature Cryptography Component
The newest version!
/*
 * Demoiselle Framework
 * Copyright (C) 2016 SERPRO
 * ----------------------------------------------------------------------------
 * This file is part of Demoiselle Framework.
 *
 * Demoiselle Framework is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License version 3
 * along with this program; if not,  see 
 * or write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA  02110-1301, USA.
 * ----------------------------------------------------------------------------
 * Este arquivo é parte do Framework Demoiselle.
 *
 * O Framework Demoiselle é um software livre; você pode redistribuí-lo e/ou
 * modificá-lo dentro dos termos da GNU LGPL versão 3 como publicada pela Fundação
 * do Software Livre (FSF).
 *
 * Este programa é distribuído na esperança que possa ser útil, mas SEM NENHUMA
 * GARANTIA; sem uma garantia implícita de ADEQUAÇÃO a qualquer MERCADO ou
 * APLICAÇÃO EM PARTICULAR. Veja a Licença Pública Geral GNU/LGPL em português
 * para maiores detalhes.
 *
 * Você deve ter recebido uma cópia da GNU LGPL versão 3, sob o título
 * "LICENCA.txt", junto com esse programa. Se não, acesse 
 * ou escreva para a Fundação do Software Livre (FSF) Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02111-1301, USA.
 */

package org.demoiselle.signer.cryptography;

import java.io.File;

import org.demoiselle.signer.cryptography.implementation.DigestImpl;

/**
 * Defines the default behavior for using digest algorithms.
 *
 * @see DigestImpl
 */
public interface Digest {

	/**
	 * Set the algorithm used by the digest method.
	 *
	 * @param algorithm algorithm representation
	 * @see DigestAlgorithmEnum
	 */
	void setAlgorithm(DigestAlgorithmEnum algorithm);

	/**
	 * Set the algorithm used by the digest method.
	 *
	 * @param algorithm Algorithm name
	 */
	void setAlgorithm(String algorithm);

	/**
	 * Method responsible for generating a digest of the content passed as a parameter,
	 * using the algorithm set by the setAlgorithm () method.
	 *
	 * @param content content to be processed
	 * @return digest
	 */
	byte[] digest(byte[] content);

	/**
	 * Returns the digest of an array of bytes in hexadecimal character format.
	 *
	 * @param content content to be processed
	 * @return digest
	 */
	String digestHex(byte[] content);

	/**
	 * Returns the Digest of a file
	 *
	 * @param file file to be processed
	 * @return digest
	 */
	byte[] digestFile(File file);

	/**
	 * Returns the summary of a file in hexadecimal character format
	 *
	 * @param file file to be processed
	 * @return digest
	 */
	String digestFileHex(File file);

}