Package eu.europa.esig.dss.model

Class CommonDocument

java.lang.Object

eu.europa.esig.dss.model.CommonDocument

All Implemented Interfaces:

DSSDocument, Serializable

Direct Known Subclasses:

CMSSignedDocument, DigestDocument, FileDocument, InMemoryDocument

public abstract class CommonDocument
extends Object
implements DSSDocument

This class implements the default methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	absolutePath
protected EnumMap<DigestAlgorithm,String>	base64EncodeDigestMap
protected MimeType	mimeType
protected String	name

Constructor Summary

Constructors

Constructor	Description
CommonDocument()

Method Summary

Modifier and Type	Method	Description
String	getAbsolutePath()	Returns the String representing the absolute path to the encapsulated document.
String	getDigest(DigestAlgorithm digestAlgorithm)	This method returns the encoded digest value of the current DSSDocument using the base64 algorithm.
MimeType	getMimeType()	Returns the mime-type of the DSSDocument.
String	getName()	Returns the name of the document.
void	save(String path)	Save the content of the DSSDocument to the file.
void	setAbsolutePath(String absolutePath)
void	setMimeType(MimeType mimeType)	This method sets the mime-type of the DSSDocument.
void	setName(String name)	This method sets the name of the DSSDocument.
String	toString()
void	writeTo(OutputStream stream)	Writes the content of the document to the provided OutputStream

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.europa.esig.dss.model.DSSDocument

openStream

Field Detail

base64EncodeDigestMap

protected EnumMap<DigestAlgorithm,String> base64EncodeDigestMap

mimeType

protected MimeType mimeType

name

protected String name

absolutePath

protected String absolutePath

Constructor Detail

CommonDocument

public CommonDocument()

Method Detail

save

public void save(String path)
          throws IOException

Description copied from interface: DSSDocument

Save the content of the DSSDocument to the file.

Specified by:

save in interface DSSDocument

Parameters:

path - the path to the file to be created

Throws:

IOException - if any IO error happens

writeTo

public void writeTo(OutputStream stream)
             throws IOException

Description copied from interface: DSSDocument

Writes the content of the document to the provided OutputStream

Specified by:

writeTo in interface DSSDocument

Parameters:

stream - the output stream where to write

Throws:

IOException - if any IO error happens

getMimeType

public MimeType getMimeType()

Description copied from interface: DSSDocument

Returns the mime-type of the DSSDocument.

Specified by:

getMimeType in interface DSSDocument

Returns:

MimeType

setMimeType

public void setMimeType(MimeType mimeType)

Description copied from interface: DSSDocument

This method sets the mime-type of the DSSDocument.

Specified by:

setMimeType in interface DSSDocument

Parameters:

mimeType - MimeType

getName

public String getName()

Description copied from interface: DSSDocument

Returns the name of the document. If the DSSDocument was built based on the File then the file name is returned.

Specified by:

getName in interface DSSDocument

Returns:

String representing the name of the current DSSDocument

setName

public void setName(String name)

Description copied from interface: DSSDocument

This method sets the name of the DSSDocument.

Specified by:

setName in interface DSSDocument

Parameters:

name - the document name

getAbsolutePath

public String getAbsolutePath()

Description copied from interface: DSSDocument

Returns the String representing the absolute path to the encapsulated document.

Specified by:

getAbsolutePath in interface DSSDocument

Returns:

String representing the absolute path to the encapsulated document.

setAbsolutePath

public void setAbsolutePath(String absolutePath)

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

Parameters:

digestAlgorithm - DigestAlgorithm

Returns:

base64 encoded String

toString

public String toString()

Overrides:

toString in class Object