Package eu.europa.esig.dss.model

Class DigestDocument

java.lang.Object

eu.europa.esig.dss.model.CommonDocument

eu.europa.esig.dss.model.DigestDocument

All Implemented Interfaces:

DSSDocument, Serializable

public class DigestDocument
extends CommonDocument

Digest representation of a DSSDocument. It can be used to handle a large file to be signed. The computation of the digest associated to the file can be done externally.

See Also:

Serialized Form

Field Summary

Fields inherited from class eu.europa.esig.dss.model.CommonDocument

absolutePath, base64EncodeDigestMap, mimeType, name

Constructor Summary

Constructors

Constructor	Description
DigestDocument()	Creates DigestDocument with an empty digest map.
DigestDocument(DigestAlgorithm digestAlgorithm, String base64EncodeDigest)	Creates DigestDocument.
DigestDocument(DigestAlgorithm digestAlgorithm, String base64EncodeDigest, String name)	Creates DigestDocument.

Method Summary

Modifier and Type	Method	Description
void	addDigest(DigestAlgorithm digestAlgorithm, String base64EncodeDigest)	This method allows to add a pair: DigestAlgorithm and the corresponding digest value calculated externally on the encapsulated file.
String	getDigest(DigestAlgorithm digestAlgorithm)	This method returns the encoded digest value of the current DSSDocument using the base64 algorithm.
Digest	getExistingDigest()
InputStream	openStream()	Opens a InputStream on the DSSDocument contents.
void	save(String filePath)	Save the content of the DSSDocument to the file.

Methods inherited from class eu.europa.esig.dss.model.CommonDocument

getAbsolutePath, getMimeType, getName, setAbsolutePath, setMimeType, setName, toString, writeTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DigestDocument

public DigestDocument()

Creates DigestDocument with an empty digest map. Initial algorithm and digest must be specified in order to use the object

DigestDocument

public DigestDocument(DigestAlgorithm digestAlgorithm,
                      String base64EncodeDigest)

Creates DigestDocument.

Parameters:

digestAlgorithm - DigestAlgorithm

base64EncodeDigest - the corresponding base 64 encoded digest value

DigestDocument

public DigestDocument(DigestAlgorithm digestAlgorithm,
                      String base64EncodeDigest,
                      String name)

Creates DigestDocument.

Parameters:

digestAlgorithm - DigestAlgorithm

base64EncodeDigest - the corresponding base 64 encoded digest value

name - the name of the document

Method Detail

addDigest

public void addDigest(DigestAlgorithm digestAlgorithm,
                      String base64EncodeDigest)

This method allows to add a pair: DigestAlgorithm and the corresponding digest value calculated externally on the encapsulated file. The digest value is base 64 encoded.

Parameters:

digestAlgorithm - DigestAlgorithm

base64EncodeDigest - the corresponding base 64 encoded digest value

getDigest

public String getDigest(DigestAlgorithm digestAlgorithm)

Description copied from interface: DSSDocument

This method returns the encoded digest value of the current DSSDocument using the base64 algorithm.

Specified by:

getDigest in interface DSSDocument

Overrides:

getDigest in class CommonDocument

Parameters:

digestAlgorithm - DigestAlgorithm

Returns:

base64 encoded String

getExistingDigest

public Digest getExistingDigest()

openStream

public InputStream openStream()

Description copied from interface: DSSDocument

Opens a InputStream on the DSSDocument contents. The type of the InputStream depends on the type of the DSSDocument.

Returns:

an InputStream

save

public void save(String filePath)
          throws IOException

Description copied from interface: DSSDocument

Save the content of the DSSDocument to the file.

Specified by:

save in interface DSSDocument

Overrides:

save in class CommonDocument

Parameters:

filePath - the path to the file to be created

Throws:

IOException - if any IO error happens