Class CommonDocument

java.lang.Object
eu.europa.esig.dss.model.CommonDocument
All Implemented Interfaces:
DSSDocument, Serializable
Direct Known Subclasses:
CMSSignedContentDocument, CMSSignedDocument, ContainerEntryDocument, DigestDocument, DocumentWithSha2, DOMDocument, FileArchiveEntry, FileDocument, InMemoryDocument, PdfByteRangeDocument
public abstract class CommonDocument extends Object implements DSSDocument
This class implements the default methods.
See Also:

  • Field Details

    • digestMap

      protected EnumMap<DigestAlgorithm, byte[]> digestMap
      Cached map of DigestAlgorithms and the corresponding digests for the document

    • mimeType

      protected MimeType mimeType
      The MimeType of the document

    • name

      protected String name
      The document name

  • Constructor Details

    • CommonDocument

      protected CommonDocument()
      Default constructor instantiating object with null values and empty digest map

  • Method Details

    • 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

    • getDigest

      public Digest getDigest(DigestAlgorithm digestAlgorithm)
      Description copied from interface: DSSDocument
      This method returns the digest value of the current DSSDocument using the base64 algorithm.
      Specified by:
      getDigest in interface DSSDocument
      Parameters:
      digestAlgorithm - DigestAlgorithm
      Returns:
      Digest

    • getDigestValue

      public byte[] getDigestValue(DigestAlgorithm digestAlgorithm)
      Description copied from interface: DSSDocument
      This method returns digest value of the current document's content using the provided digestAlgorithm
      Specified by:
      getDigestValue in interface DSSDocument
      Parameters:
      digestAlgorithm - DigestAlgorithm to get digest for
      Returns:
      byte array representing digest of the document

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object