Uses of Interface eu.europa.esig.dss.model.DSSDocument (Digital Signature Services 5.12.1 API)

Uses of DSSDocument in eu.europa.esig.dss

Methods in eu.europa.esig.dss that return DSSDocument

Modifier and Type

Method

Description

static DSSDocument

DomUtils.createDssDocumentFromDomDocument(Document document, String name)

This method creates a new InMemoryDocument with the Document content and the given name

Methods in eu.europa.esig.dss that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

AbstractSignatureParameters.getDetachedContents()

This method returns the documents to sign.

List<DSSDocument>

ProfileParameters.getDetachedContents()

Gets the detached contents

Methods in eu.europa.esig.dss with parameters of type DSSDocument

Modifier and Type

Method

Description

static Document

DomUtils.buildDOM(DSSDocument dssDocument)

This method returns the Document created based on the DSSDocument.

static boolean

DomUtils.isDOM(DSSDocument dssDocument)

This method returns true if the provided document is a valid XML Document

static boolean

DomUtils.startsWithXmlPreamble(DSSDocument document)

Checks if the given document starts with an XML Preamble '<' Processes values with or without BOM-encoding NOTE: does not check XML-conformity of the whole file call isDOM(DSSDocument) for a deep check

Method parameters in eu.europa.esig.dss with type arguments of type DSSDocument

Modifier and Type

Method

Description

void

AbstractSignatureParameters.setDetachedContents(List<DSSDocument> detachedContents)

When signing this method is internally invoked by the AbstractSignatureService and the related variable detachedContent is overwritten by the service parameter.

void

ProfileParameters.setDetachedContents(List<DSSDocument> detachedContents)

Sets the detached contents
Uses of DSSDocument in eu.europa.esig.dss.asic.cades

Constructors in eu.europa.esig.dss.asic.cades with parameters of type DSSDocument

Modifier

Constructor

Description

ASiCWithCAdESContainerExtractor(DSSDocument archive)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.merge

Methods in eu.europa.esig.dss.asic.cades.merge that return DSSDocument

Modifier and Type

Method

Description

protected DSSDocument

AbstractASiCWithCAdESContainerMerger.mergeCmsSignatures(List<DSSDocument> signatureDocuments)

This method merges signature documents representing CMS signatures into single CMS signature document.

Methods in eu.europa.esig.dss.asic.cades.merge that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

protected List<DSSDocument>

AbstractASiCWithCAdESContainerMerger.getAllSignatureDocuments(ASiCContent... asicContents)

This method returns all signature documents extracted from given ASiCContent containers

Methods in eu.europa.esig.dss.asic.cades.merge with parameters of type DSSDocument

Modifier and Type

Method

Description

ASiCContainerMerger

ASiCWithCAdESContainerMergerFactory.create(DSSDocument... containers)

protected AbstractASiCContainerExtractor

AbstractASiCWithCAdESContainerMerger.getContainerExtractor(DSSDocument container)

protected boolean

AbstractASiCWithCAdESContainerMerger.isSupported(DSSDocument container)

protected boolean

ASiCEWithCAdESContainerMerger.isSupported(DSSDocument container)

boolean

ASiCSWithCAdESContainerMerger.isSupported(DSSDocument container)

boolean

ASiCWithCAdESContainerMergerFactory.isSupported(DSSDocument... containers)

Method parameters in eu.europa.esig.dss.asic.cades.merge with type arguments of type DSSDocument

Modifier and Type

Method

Description

protected DSSDocument

AbstractASiCWithCAdESContainerMerger.mergeCmsSignatures(List<DSSDocument> signatureDocuments)

This method merges signature documents representing CMS signatures into single CMS signature document.

Constructors in eu.europa.esig.dss.asic.cades.merge with parameters of type DSSDocument

Modifier

Constructor

Description

protected

AbstractASiCWithCAdESContainerMerger(DSSDocument... containers)

This constructor is used to create an ASiC With CAdES container merger from provided container documents

ASiCEWithCAdESContainerMerger(DSSDocument... containers)

This constructor is used to create an ASiC-E With CAdES container merger from provided container documents

ASiCSWithCAdESContainerMerger(DSSDocument... containers)

This constructor is used to create an ASiC-S With CAdES container merger from provided container documents
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature

Methods in eu.europa.esig.dss.asic.cades.signature that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCWithCAdESService.addSignaturePolicyStore(DSSDocument asicContainer, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the ASiC with CAdES Signature

DSSDocument

ASiCWithCAdESService.counterSignSignature(DSSDocument asicContainer, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithCAdESService.extendDocument(DSSDocument toExtendDocument, ASiCWithCAdESSignatureParameters parameters)

DSSDocument

GetDataToSignASiCWithCAdESHelper.getToBeSigned()

Returns a signed file document NOTE: In CMS/CAdES, only one file can be signed

DSSDocument

ASiCWithCAdESService.signDocument(List<DSSDocument> toSignDocuments, ASiCWithCAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithCAdESService.timestamp(List<DSSDocument> toTimestampDocuments, ASiCWithCAdESTimestampParameters parameters)

Methods in eu.europa.esig.dss.asic.cades.signature that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

GetDataToSignASiCWithCAdESHelper.getDetachedContents()

Returns a list of detached documents NOTE: In case of ASiC-S signature, we need the detached content

protected List<DSSDocument>

ASiCWithCAdESCounterSignatureHelper.getDetachedDocuments(String signatureFilename)

Methods in eu.europa.esig.dss.asic.cades.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCWithCAdESService.addSignaturePolicyStore(DSSDocument asicContainer, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the ASiC with CAdES Signature

protected void

ASiCWithCAdESCounterSignatureHelper.checkCounterSignaturePossible(DSSDocument signatureDocument)

DSSDocument

ASiCWithCAdESService.counterSignSignature(DSSDocument asicContainer, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithCAdESService.extendDocument(DSSDocument toExtendDocument, ASiCWithCAdESSignatureParameters parameters)

protected AbstractASiCContainerExtractor

ASiCWithCAdESService.getArchiveExtractor(DSSDocument archive)

protected AbstractASiCContainerExtractor

ASiCWithCAdESASiCContentBuilder.getContainerExtractor(DSSDocument archiveDocument)

ToBeSigned

ASiCWithCAdESService.getDataToBeCounterSigned(DSSDocument asicContainer, CAdESCounterSignatureParameters parameters)

protected DocumentValidator

ASiCWithCAdESCounterSignatureHelper.getDocumentValidator(DSSDocument signatureDocument)

protected boolean

ASiCWithCAdESASiCContentBuilder.isAcceptableContainerFormat(DSSDocument archiveDocument)

protected boolean

ASiCWithCAdESSignatureExtension.isCoveredByManifest(ASiCContent asicContent, DSSDocument signature)

Verifies whether the signature document is covered by an Archive Manifest

Method parameters in eu.europa.esig.dss.asic.cades.signature with type arguments of type DSSDocument

Modifier and Type

Method

Description

TimestampToken

ASiCWithCAdESService.getContentTimestamp(List<DSSDocument> toSignDocuments, ASiCWithCAdESSignatureParameters parameters)

ToBeSigned

ASiCWithCAdESService.getDataToSign(List<DSSDocument> toSignDocuments, ASiCWithCAdESSignatureParameters parameters)

DSSDocument

ASiCWithCAdESService.signDocument(List<DSSDocument> toSignDocuments, ASiCWithCAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithCAdESService.timestamp(List<DSSDocument> toTimestampDocuments, ASiCWithCAdESTimestampParameters parameters)

Constructors in eu.europa.esig.dss.asic.cades.signature with parameters of type DSSDocument

Modifier

Constructor

Description

protected

ASiCWithCAdESCounterSignatureHelper(DSSDocument asicContainer)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature.asice

Methods in eu.europa.esig.dss.asic.cades.signature.asice that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

DataToSignASiCEWithCAdESHelper.getToBeSigned()

Methods in eu.europa.esig.dss.asic.cades.signature.asice that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

DataToSignASiCEWithCAdESHelper.getDetachedContents()

Constructors in eu.europa.esig.dss.asic.cades.signature.asice with parameters of type DSSDocument

Modifier

Constructor

Description

DataToSignASiCEWithCAdESHelper(ASiCContent asicContent, DSSDocument toBeSigned)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature.asics

Methods in eu.europa.esig.dss.asic.cades.signature.asics that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

DataToSignASiCSWithCAdESFromArchive.getToBeSigned()

DSSDocument

DataToSignASiCSWithCAdESFromFiles.getToBeSigned()

Methods in eu.europa.esig.dss.asic.cades.signature.asics that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

DataToSignASiCSWithCAdESFromArchive.getDetachedContents()

List<DSSDocument>

DataToSignASiCSWithCAdESFromFiles.getDetachedContents()
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature.manifest

Methods in eu.europa.esig.dss.asic.cades.signature.manifest that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCEWithCAdESArchiveManifestBuilder.build()

Builds the ArchiveManifest and returns the Document Node

DSSDocument

ASiCEWithCAdESManifestBuilder.build()

Builds the manifest and returns the document

Methods in eu.europa.esig.dss.asic.cades.signature.manifest with parameters of type DSSDocument

Modifier and Type

Method

Description

protected Element

AbstractManifestBuilder.addDataObjectReference(Document documentDom, Element asicManifestDom, DSSDocument document, DigestAlgorithm digestAlgorithm)

Adds a <DataObjectReference> element

Constructors in eu.europa.esig.dss.asic.cades.signature.manifest with parameters of type DSSDocument

Modifier

Constructor

Description

ASiCEWithCAdESArchiveManifestBuilder(ASiCContent asicContent, DSSDocument lastArchiveManifest, DigestAlgorithm digestAlgorithm, String timestampFileUri)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.timestamp

Methods in eu.europa.esig.dss.asic.cades.timestamp that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCWithCAdESTimestampService.timestamp(List<DSSDocument> documents, ASiCWithCAdESTimestampParameters parameters)

The method is used to timestamp a list of documents

Method parameters in eu.europa.esig.dss.asic.cades.timestamp with type arguments of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCWithCAdESTimestampService.timestamp(List<DSSDocument> documents, ASiCWithCAdESTimestampParameters parameters)

The method is used to timestamp a list of documents
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.validation

Methods in eu.europa.esig.dss.asic.cades.validation that return DSSDocument

Modifier and Type

Method

Description

static DSSDocument

ASiCWithCAdESManifestParser.getLinkedManifest(List<DSSDocument> manifestDocuments, String signatureName)

Returns the relative manifests for the given signature name

static DSSDocument

ASiCWithCAdESUtils.getSignedDocument(ASiCContent extractResult, String signatureFilename)

Returns a list of signed documents by a signature with a given signatureFilename

Methods in eu.europa.esig.dss.asic.cades.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

ASiCContainerWithCAdESValidator.getArchiveDocuments()

List<DSSDocument>

ASiCContainerWithCAdESValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

Methods in eu.europa.esig.dss.asic.cades.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

ASiCContainerWithCAdESValidatorFactory.create(DSSDocument document)

static ManifestFile

ASiCWithCAdESManifestParser.getManifestFile(DSSDocument manifestDocument)

Parses and converts DSSDocument to ManifestFile

boolean

ASiCContainerWithCAdESValidator.isSupported(DSSDocument dssDocument)

boolean

ASiCContainerWithCAdESValidatorFactory.isSupported(DSSDocument document)

Method parameters in eu.europa.esig.dss.asic.cades.validation with type arguments of type DSSDocument

Modifier and Type

Method

Description

static DSSDocument

ASiCWithCAdESManifestParser.getLinkedManifest(List<DSSDocument> manifestDocuments, String signatureName)

Returns the relative manifests for the given signature name

static boolean

ASiCWithCAdESUtils.isCoveredByManifest(List<DSSDocument> manifestDocuments, String filename)

Checks if a document (e.g.

void

ASiCWithCAdESTimestampValidator.setArchiveDocuments(List<DSSDocument> archiveDocuments)

Sets the document embedded inside package.zip, when applicable

void

ASiCWithCAdESTimestampValidator.setOriginalDocuments(List<DSSDocument> originalDocuments)

Sets the original documents present in the ASiC container

Constructors in eu.europa.esig.dss.asic.cades.validation with parameters of type DSSDocument

Modifier

Constructor

Description

ASiCContainerWithCAdESValidator(DSSDocument asicContainer)

The default constructor

ASiCWithCAdESTimestampValidator(DSSDocument timestamp)

Default constructor

ASiCWithCAdESTimestampValidator(DSSDocument timestamp, TimestampType type)

Default constructor with a timestamp type

Constructor parameters in eu.europa.esig.dss.asic.cades.validation with type arguments of type DSSDocument

Modifier

Constructor

Description

ASiCEWithCAdESManifestValidator(ManifestFile manifest, List<DSSDocument> signedDocuments)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.cades.validation.scope

Methods in eu.europa.esig.dss.asic.cades.validation.scope with parameters of type DSSDocument

Modifier and Type

Method

Description

protected List<SignatureScope>

ASiCWithCAdESTimestampScopeFinder.getTimestampSignatureScopeForDocument(DSSDocument document)

Method parameters in eu.europa.esig.dss.asic.cades.validation.scope with type arguments of type DSSDocument

Modifier and Type

Method

Description

void

ASiCWithCAdESTimestampScopeFinder.setArchiveDocuments(List<DSSDocument> archiveDocuments)

Sets a list of package.zip archive documents

void

ASiCWithCAdESTimestampScopeFinder.setContainerDocuments(List<DSSDocument> containerDocuments)

Sets a list of container original documents
Uses of DSSDocument in eu.europa.esig.dss.asic.common

Subinterfaces of DSSDocument in eu.europa.esig.dss.asic.common

Modifier and Type

Interface

Description

interface

DSSZipEntryDocument

Contains metadata for a ZIP-container entry

Classes in eu.europa.esig.dss.asic.common that implement DSSDocument

Modifier and Type

Class

Description

class

ContainerEntryDocument

Represents an entry within a ZIP archive, containing its metadata and file's content.

class

FileArchiveEntry

Internal class that is used for performance purposes, accessing ZIP-archive entries on request, instead of loading all files into memory.

Methods in eu.europa.esig.dss.asic.common that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

SecureContainerHandler.createZipArchive(List<DSSDocument> containerEntries, Date creationTime, String zipComment)

DSSDocument

ZipContainerHandler.createZipArchive(List<DSSDocument> containerEntries, Date creationTime, String zipComment)

Creates a ZIP-Archive with the given containerEntries

DSSDocument

ZipUtils.createZipArchive(ASiCContent asicContent, Date creationTime)

Creates a ZIP-Archive with the given asicContent

DSSDocument

ZipUtils.createZipArchive(List<DSSDocument> containerEntries, Date creationTime, String zipComment)

Creates a ZIP-Archive with the given containerEntries

DSSDocument

ASiCContent.getAsicContainer()

Gets the original ASiC container

DSSDocument

ASiCContent.getMimeTypeDocument()

Gets mimetype document

Methods in eu.europa.esig.dss.asic.common that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

SecureContainerHandler.extractContainerContent(DSSDocument zipArchive)

List<DSSDocument>

ZipContainerHandler.extractContainerContent(DSSDocument zipArchive)

Extracts a list of DSSDocument from the given ZIP-archive

List<DSSDocument>

ZipUtils.extractContainerContent(DSSDocument zipPackage)

Extracts a list of DSSDocument from the given ZIP-archive

List<DSSDocument>

ASiCContent.getAllDocuments()

Gets all documents

List<DSSDocument>

ASiCContent.getAllManifestDocuments()

Returns a list of all found manifest documents

List<DSSDocument>

ASiCContent.getArchiveManifestDocuments()

Gets archive manifest documents (ASiC with CAdES only)

List<DSSDocument>

ASiCContent.getContainerDocuments()

Gets "package.zip" documents

List<DSSDocument>

ASiCContent.getFolders()

Returns a list of folders present within the container

List<DSSDocument>

ASiCContent.getManifestDocuments()

Gets manifest documents

static List<DSSDocument>

ASiCUtils.getRootLevelDocuments(List<DSSDocument> documents)

This method returns root-level documents across the provided list of documents

List<DSSDocument>

ASiCContent.getRootLevelSignedDocuments()

This method returns a list of documents at the root level within the container

static List<DSSDocument>

ASiCUtils.getRootLevelSignedDocuments(ASiCContent asicContent)

This method retrieves signed document from a root level of the container (used for ASiC-E container)

List<DSSDocument>

ASiCContent.getSignatureDocuments()

Gets signature documents

List<DSSDocument>

ASiCContent.getSignedDocuments()

Gets signed documents

List<DSSDocument>

ASiCContent.getTimestampDocuments()

Gets timestamp documents (ASiC with CAdES only)

List<DSSDocument>

ASiCContent.getUnsupportedDocuments()

Gets unsupported documents

Methods in eu.europa.esig.dss.asic.common with parameters of type DSSDocument

Modifier and Type

Method

Description

static void

ASiCUtils.addOrReplaceDocument(List<DSSDocument> documentList, DSSDocument newDocument)

This method searches for a document in a documentList with a name of newDocumentVersion and replaces the found entry with the updated version or adds the document to the given list if no such entry has been found

List<DSSDocument>

SecureContainerHandler.extractContainerContent(DSSDocument zipArchive)

List<DSSDocument>

ZipContainerHandler.extractContainerContent(DSSDocument zipArchive)

Extracts a list of DSSDocument from the given ZIP-archive

List<DSSDocument>

ZipUtils.extractContainerContent(DSSDocument zipPackage)

Extracts a list of DSSDocument from the given ZIP-archive

List<String>

SecureContainerHandler.extractEntryNames(DSSDocument zipArchive)

List<String>

ZipContainerHandler.extractEntryNames(DSSDocument zipArchive)

Returns a list of ZIP archive entry names

List<String>

ZipUtils.extractEntryNames(DSSDocument zipPackage)

Returns a list of ZIP archive entry names

static ASiCContainerType

ASiCUtils.getContainerType(DSSDocument archiveContainer)

This method verifies type of the provided container document

static MimeType

ASiCUtils.getMimeType(DSSDocument mimeTypeDocument)

Extracts and returns MimeType from the document

static String

ASiCUtils.getZipComment(DSSDocument archiveContainer)

Returns a zip comment String from the ASiC container

static boolean

ASiCUtils.isASiCEContainer(DSSDocument container)

This method verifies whether the given container is of ASiC-E format type

static boolean

ASiCUtils.isASiCSContainer(DSSDocument container)

This method verifies whether the given container is of ASiC-S format type

static boolean

ASiCUtils.isContainerOpenDocument(DSSDocument archiveContainer)

Checks if the archive represents an OpenDocument

static boolean

ASiCUtils.isOpenDocument(DSSDocument mimeTypeDoc)

Checks if the mimeType document defines an OpenDocument

static boolean

ASiCUtils.isZip(DSSDocument document)

Checks if the document is a ZIP container

void

ASiCContent.setAsicContainer(DSSDocument asicContainer)

Sets the original ASiC container

void

ASiCContent.setMimeTypeDocument(DSSDocument mimeTypeDocument)

Sets mimetype document

Method parameters in eu.europa.esig.dss.asic.common with type arguments of type DSSDocument

Modifier and Type

Method

Description

static void

ASiCUtils.addOrReplaceDocument(List<DSSDocument> documentList, DSSDocument newDocument)

This method searches for a document in a documentList with a name of newDocumentVersion and replaces the found entry with the updated version or adds the document to the given list if no such entry has been found

protected void

AbstractASiCFilenameFactory.assertFilenameValid(String filename, List<DSSDocument> documentsOfType)

This method verifies whether the given filename represents a valid document name within a container

DSSDocument

SecureContainerHandler.createZipArchive(List<DSSDocument> containerEntries, Date creationTime, String zipComment)

DSSDocument

ZipContainerHandler.createZipArchive(List<DSSDocument> containerEntries, Date creationTime, String zipComment)

Creates a ZIP-Archive with the given containerEntries

DSSDocument

ZipUtils.createZipArchive(List<DSSDocument> containerEntries, Date creationTime, String zipComment)

Creates a ZIP-Archive with the given containerEntries

static List<DSSDocument>

ASiCUtils.getRootLevelDocuments(List<DSSDocument> documents)

This method returns root-level documents across the provided list of documents

void

ASiCContent.setArchiveManifestDocuments(List<DSSDocument> archiveManifestDocuments)

Sets archive manifest documents (ASiC with CAdES only)

void

ASiCContent.setContainerDocuments(List<DSSDocument> containerDocuments)

Sets package.zip" documents

void

ASiCContent.setFolders(List<DSSDocument> folders)

Sets a list of folders present within an archive

void

ASiCContent.setManifestDocuments(List<DSSDocument> manifestDocuments)

Sets manifest documents

void

ASiCContent.setSignatureDocuments(List<DSSDocument> signatureDocuments)

Sets signature documents

void

ASiCContent.setSignedDocuments(List<DSSDocument> signedDocuments)

Sets signed documents

void

ASiCContent.setTimestampDocuments(List<DSSDocument> timestampDocuments)

Sets timestamp documents (ASiC with CAdES only)

void

ASiCContent.setUnsupportedDocuments(List<DSSDocument> unsupportedDocuments)

Sets unsupported documents

static List<ManifestEntry>

ASiCUtils.toSimpleManifestEntries(List<DSSDocument> documents)

Transforms a list of given documents to a list of "simple" (only basic information) manifest entries

Constructors in eu.europa.esig.dss.asic.common with parameters of type DSSDocument

Modifier

Constructor

Description

protected

AbstractASiCContainerExtractor(DSSDocument asicContainer)

The default constructor

ContainerEntryDocument(DSSDocument content)

Default constructor

ContainerEntryDocument(DSSDocument content, DSSZipEntry zipEntry)

Constructor with provided DSSZipEntry
Uses of DSSDocument in eu.europa.esig.dss.asic.common.merge

Methods in eu.europa.esig.dss.asic.common.merge that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCContainerMerger.merge()

Merges given containers to a new container document, when possible

DSSDocument

DefaultContainerMerger.merge()

Methods in eu.europa.esig.dss.asic.common.merge with parameters of type DSSDocument

Modifier and Type

Method

Description

ASiCContainerMerger

ASiCContainerMergerFactory.create(DSSDocument... containers)

Creates a new ASiCContainerMerger for the given ZIP-archive containers

static ASiCContainerMerger

DefaultContainerMerger.fromDocuments(DSSDocument... containers)

This method loads a relevant ASiCContainerMerger to be used to merge given container documents

protected abstract AbstractASiCContainerExtractor

DefaultContainerMerger.getContainerExtractor(DSSDocument container)

This method returns a relevant ASiC container extractor

boolean

ASiCContainerMerger.isSupported(DSSDocument... containers)

Returns whether the format of given containers is supported by the current ASiCContainerMerger

boolean

ASiCContainerMergerFactory.isSupported(DSSDocument... containers)

Returns whether the format of given containers is supported by the current ASiCContainerMerger

protected abstract boolean

DefaultContainerMerger.isSupported(DSSDocument container)

This method verifies whether the provided container is supported by the current class

boolean

DefaultContainerMerger.isSupported(DSSDocument... containers)

Constructors in eu.europa.esig.dss.asic.common.merge with parameters of type DSSDocument

Modifier

Constructor

Description

protected

DefaultContainerMerger(DSSDocument... containers)

This constructor is used to create an ASiCContainerMerger from provided container documents
Uses of DSSDocument in eu.europa.esig.dss.asic.common.signature

Fields in eu.europa.esig.dss.asic.common.signature declared as DSSDocument

Modifier and Type

Field

Description

protected final DSSDocument

ASiCCounterSignatureHelper.asicContainer

The document representing an ASiC container

Methods in eu.europa.esig.dss.asic.common.signature that return DSSDocument

Modifier and Type

Method

Description

protected DSSDocument

AbstractASiCSignatureService.buildASiCContainer(ASiCContent asicContent, Date creationTime)

Creates a ZIP-Archive by copying the provided documents to the new container

protected DSSDocument

AbstractASiCDataToSignHelperBuilder.createPackageZip(List<DSSDocument> documents, Date signingDate)

Creates a zip with all files to be signed

DSSDocument

ASiCCounterSignatureHelper.extractSignatureDocument(String signatureId)

Returns a file containing a signature with the given id

protected DSSDocument

AbstractASiCDataToSignHelperBuilder.getASiCSSignedDocument(List<DSSDocument> filesToBeSigned, Date signingDate)

This method returns a document to be signed in case of an ASiC-S container

DSSDocument

AbstractASiCSignatureService.signDocument(DSSDocument toSignDocument, SP parameters, SignatureValue signatureValue)

DSSDocument

AbstractASiCSignatureService.timestamp(DSSDocument toTimestampDocument, TP parameters)

Methods in eu.europa.esig.dss.asic.common.signature that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

protected abstract List<DSSDocument>

ASiCCounterSignatureHelper.getDetachedDocuments(String signatureFilename)

Returns a list if detached documents for a signature with a given filename

Methods in eu.europa.esig.dss.asic.common.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

protected void

ASiCCounterSignatureHelper.checkCounterSignaturePossible(DSSDocument signatureDocument)

This method verifies if a signatureDocument can be counter signed Throws an exception when an extension is not possible

protected ASiCContent

AbstractASiCSignatureService.extractCurrentArchive(DSSDocument archive)

Extracts the content (documents) of the ASiC container

protected abstract AbstractASiCContainerExtractor

AbstractASiCSignatureService.getArchiveExtractor(DSSDocument archive)

Returns a relevant ASiC container extractor for the given format

protected abstract AbstractASiCContainerExtractor

AbstractASiCContentBuilder.getContainerExtractor(DSSDocument archiveDocument)

Returns an instance of a corresponding container extractor class

TimestampToken

AbstractASiCSignatureService.getContentTimestamp(DSSDocument toSignDocument, SP parameters)

ToBeSigned

AbstractASiCSignatureService.getDataToSign(DSSDocument toSignDocument, SP parameters)

protected abstract DocumentValidator

ASiCCounterSignatureHelper.getDocumentValidator(DSSDocument signatureDocument)

Gets a Document Validator relative to the current implementation

protected String

AbstractASiCSignatureService.getFinalArchiveName(DSSDocument originalFile, SigningOperation operation, MimeType containerMimeType)

Generates and returns a final name for the archive to create

protected abstract boolean

AbstractASiCContentBuilder.isAcceptableContainerFormat(DSSDocument archiveDocument)

Method verifies whether the given archiveDocument has an acceptable to the format type

DSSDocument

AbstractASiCSignatureService.signDocument(DSSDocument toSignDocument, SP parameters, SignatureValue signatureValue)

DSSDocument

AbstractASiCSignatureService.timestamp(DSSDocument toTimestampDocument, TP parameters)

Method parameters in eu.europa.esig.dss.asic.common.signature with type arguments of type DSSDocument

Modifier and Type

Method

Description

protected void

AbstractASiCSignatureService.assertSignaturePossible(List<DSSDocument> documentsToSign)

This method verifies whether the signature creation is possible with the provided documents

ASiCContent

AbstractASiCContentBuilder.build(List<DSSDocument> documents, ASiCContainerType asicContainerType)

Builds the ASiCContent from the

protected DSSDocument

AbstractASiCDataToSignHelperBuilder.createPackageZip(List<DSSDocument> documents, Date signingDate)

Creates a zip with all files to be signed

protected DSSDocument

AbstractASiCDataToSignHelperBuilder.getASiCSSignedDocument(List<DSSDocument> filesToBeSigned, Date signingDate)

This method returns a document to be signed in case of an ASiC-S container

Constructors in eu.europa.esig.dss.asic.common.signature with parameters of type DSSDocument

Modifier

Constructor

Description

protected

ASiCCounterSignatureHelper(DSSDocument asicContainer)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.common.validation

Methods in eu.europa.esig.dss.asic.common.validation that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

AbstractASiCContainerValidator.getMimeTypeDocument()

Returns a mimetype document

Methods in eu.europa.esig.dss.asic.common.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

AbstractASiCContainerValidator.getAllDocuments()

Returns a list of all embedded documents

List<DSSDocument>

AbstractASiCContainerValidator.getAllManifestDocuments()

Returns a list of all embedded manifest documents

List<DSSDocument>

AbstractASiCContainerValidator.getArchiveDocuments()

Returns a list of archive documents embedded the container

List<DSSDocument>

AbstractASiCContainerValidator.getArchiveManifestDocuments()

Returns a list of embedded archive manifest documents

List<DSSDocument>

AbstractASiCContainerValidator.getManifestDocuments()

Returns a list of embedded signature manifest documents

List<DSSDocument>

AbstractASiCContainerValidator.getSignatureDocuments()

Returns a list of embedded signature documents

List<DSSDocument>

AbstractASiCContainerValidator.getSignedDocuments()

Returns a list of embedded signed documents

protected List<DSSDocument>

AbstractASiCContainerValidator.getSignedDocumentsASiCS(List<DSSDocument> retrievedDocs)

Returns a list of "package.zip" documents

List<DSSDocument>

AbstractASiCContainerValidator.getTimestampDocuments()

Returns a list of embedded timestamp documents

List<DSSDocument>

AbstractASiCContainerValidator.getUnsupportedDocuments()

Returns a list of unsupported documents from the container

Method parameters in eu.europa.esig.dss.asic.common.validation with type arguments of type DSSDocument

Modifier and Type

Method

Description

protected List<DSSDocument>

AbstractASiCContainerValidator.getSignedDocumentsASiCS(List<DSSDocument> retrievedDocs)

Returns a list of "package.zip" documents

Constructors in eu.europa.esig.dss.asic.common.validation with parameters of type DSSDocument

Modifier

Constructor

Description

protected

AbstractASiCContainerValidator(DSSDocument document)

The default constructor

protected

AbstractASiCContainerValidator(DSSDocument document, SignatureScopeFinder<?> signatureScopeFinder)

Constructor with a custom SignatureScopeFinder
Uses of DSSDocument in eu.europa.esig.dss.asic.xades

Methods in eu.europa.esig.dss.asic.xades that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

static List<DSSDocument>

OpenDocumentSupportUtils.getOpenDocumentCoverage(ASiCContent asicContent)

ODF 1.2 ch 3.16 An OpenDocument document that is stored in a package may have one or more digital signatures applied to the package.

Methods in eu.europa.esig.dss.asic.xades with parameters of type DSSDocument

Modifier and Type

Method

Description

static boolean

OpenDocumentSupportUtils.isExternalDataDocument(DSSDocument document)

Verifies whether the document is located within "external-data/" folder within the archive

Constructors in eu.europa.esig.dss.asic.xades with parameters of type DSSDocument

Modifier

Constructor

Description

ASiCWithXAdESContainerExtractor(DSSDocument archive)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.xades.merge

Methods in eu.europa.esig.dss.asic.xades.merge with parameters of type DSSDocument

Modifier and Type

Method

Description

ASiCContainerMerger

ASiCWithXAdESContainerMergerFactory.create(DSSDocument... containers)

protected AbstractASiCContainerExtractor

AbstractASiCWithXAdESContainerMerger.getContainerExtractor(DSSDocument container)

protected boolean

AbstractASiCWithXAdESContainerMerger.isSupported(DSSDocument container)

protected boolean

ASiCEWithXAdESContainerMerger.isSupported(DSSDocument container)

protected boolean

ASiCSWithXAdESContainerMerger.isSupported(DSSDocument container)

boolean

ASiCWithXAdESContainerMergerFactory.isSupported(DSSDocument... containers)

Constructors in eu.europa.esig.dss.asic.xades.merge with parameters of type DSSDocument

Modifier

Constructor

Description

protected

AbstractASiCWithXAdESContainerMerger(DSSDocument... containers)

This constructor is used to create an ASiC With XAdES container merger from provided container documents

ASiCEWithXAdESContainerMerger(DSSDocument... containers)

This constructor is used to create an ASiC-E With XAdES container merger from provided container documents

ASiCSWithXAdESContainerMerger(DSSDocument... containers)

This constructor is used to create an ASiC-S With XAdES container merger from provided container documents
Uses of DSSDocument in eu.europa.esig.dss.asic.xades.signature

Methods in eu.europa.esig.dss.asic.xades.signature that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCWithXAdESService.addSignaturePolicyStore(DSSDocument asicContainer, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the ASiC with XAdES Signature

DSSDocument

ASiCWithXAdESService.counterSignSignature(DSSDocument asicContainer, XAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithXAdESService.extendDocument(DSSDocument toExtendDocument, ASiCWithXAdESSignatureParameters parameters)

DSSDocument

ASiCWithXAdESService.signDocument(List<DSSDocument> toSignDocuments, ASiCWithXAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithXAdESService.timestamp(List<DSSDocument> toTimestampDocuments, XAdESTimestampParameters parameters)

Methods in eu.europa.esig.dss.asic.xades.signature that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

protected List<DSSDocument>

ASiCWithXAdESService.getDetachedContents(ASiCContent asicContent, boolean isOpenDocument)

This method returns a detached contents to be used for a signature validation

protected List<DSSDocument>

ASiCWithXAdESCounterSignatureHelper.getDetachedDocuments(String signatureFilename)

List<DSSDocument>

GetDataToSignASiCWithXAdESHelper.getToBeSigned()

Returns a list of documents to be signed (XAdES allows signing multiple files)

Methods in eu.europa.esig.dss.asic.xades.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCWithXAdESService.addSignaturePolicyStore(DSSDocument asicContainer, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the ASiC with XAdES Signature

DSSDocument

ASiCWithXAdESService.counterSignSignature(DSSDocument asicContainer, XAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithXAdESService.extendDocument(DSSDocument toExtendDocument, ASiCWithXAdESSignatureParameters parameters)

protected AbstractASiCContainerExtractor

ASiCWithXAdESService.getArchiveExtractor(DSSDocument archive)

protected AbstractASiCContainerExtractor

ASiCWithXAdESASiCContentBuilder.getContainerExtractor(DSSDocument archiveDocument)

ToBeSigned

ASiCWithXAdESService.getDataToBeCounterSigned(DSSDocument asicContainer, XAdESCounterSignatureParameters parameters)

protected DocumentValidator

ASiCWithXAdESCounterSignatureHelper.getDocumentValidator(DSSDocument signatureDocument)

protected boolean

ASiCWithXAdESASiCContentBuilder.isAcceptableContainerFormat(DSSDocument archiveDocument)

Method parameters in eu.europa.esig.dss.asic.xades.signature with type arguments of type DSSDocument

Modifier and Type

Method

Description

TimestampToken

ASiCWithXAdESService.getContentTimestamp(List<DSSDocument> toSignDocuments, ASiCWithXAdESSignatureParameters parameters)

ToBeSigned

ASiCWithXAdESService.getDataToSign(List<DSSDocument> toSignDocuments, ASiCWithXAdESSignatureParameters parameters)

DSSDocument

ASiCWithXAdESService.signDocument(List<DSSDocument> toSignDocuments, ASiCWithXAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

ASiCWithXAdESService.timestamp(List<DSSDocument> toTimestampDocuments, XAdESTimestampParameters parameters)

Constructors in eu.europa.esig.dss.asic.xades.signature with parameters of type DSSDocument

Modifier

Constructor

Description

protected

ASiCWithXAdESCounterSignatureHelper(DSSDocument asicContainer)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.asic.xades.signature.asice

Methods in eu.europa.esig.dss.asic.xades.signature.asice that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ASiCEWithXAdESManifestBuilder.build()

Builds the XML manifest

Methods in eu.europa.esig.dss.asic.xades.signature.asice that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

DataToSignASiCEWithXAdESHelper.getToBeSigned()

List<DSSDocument>

DataToSignOpenDocumentHelper.getToBeSigned()

Method parameters in eu.europa.esig.dss.asic.xades.signature.asice with type arguments of type DSSDocument

Modifier and Type

Method

Description

ASiCEWithXAdESManifestBuilder

ASiCEWithXAdESManifestBuilder.setDocuments(List<DSSDocument> documents)

Sets documents to be included into the Manifest WARN: shall not be used together with setEntries(entries)
Uses of DSSDocument in eu.europa.esig.dss.asic.xades.signature.asics

Methods in eu.europa.esig.dss.asic.xades.signature.asics that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

DataToSignASiCSWithXAdESHelper.getToBeSigned()
Uses of DSSDocument in eu.europa.esig.dss.asic.xades.validation

Methods in eu.europa.esig.dss.asic.xades.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

ASiCContainerWithXAdESValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

Methods in eu.europa.esig.dss.asic.xades.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

ASiCContainerWithXAdESValidatorFactory.create(DSSDocument document)

boolean

ASiCContainerWithXAdESValidator.isSupported(DSSDocument dssDocument)

boolean

ASiCContainerWithXAdESValidatorFactory.isSupported(DSSDocument document)

Constructors in eu.europa.esig.dss.asic.xades.validation with parameters of type DSSDocument

Modifier

Constructor

Description

ASiCContainerWithXAdESValidator(DSSDocument asicContainer)

The default constructor

ASiCEWithXAdESManifestParser(DSSDocument manifestDocument)

Constructor with a manifest document only (no assigned signature)

ASiCEWithXAdESManifestParser(DSSDocument signatureDocument, DSSDocument manifestDocument)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.cades

Methods in eu.europa.esig.dss.cades that return DSSDocument

Modifier and Type

Method

Description

static DSSDocument

CMSUtils.getOriginalDocument(org.bouncycastle.cms.CMSSignedData cmsSignedData, List<DSSDocument> detachedDocuments)

Returns the original document from the provided cmsSignedData

Methods in eu.europa.esig.dss.cades with parameters of type DSSDocument

Modifier and Type

Method

Description

static org.bouncycastle.cms.CMSTypedData

CMSUtils.getContentToBeSigned(DSSDocument toSignData)

Returns the content to be signed

static org.bouncycastle.operator.DigestCalculatorProvider

CMSUtils.getDigestCalculatorProvider(DSSDocument toSignDocument, DigestAlgorithm digestAlgorithm)

Returns a DigestCalculatorProvider

Method parameters in eu.europa.esig.dss.cades with type arguments of type DSSDocument

Modifier and Type

Method

Description

static DSSDocument

CMSUtils.getOriginalDocument(org.bouncycastle.cms.CMSSignedData cmsSignedData, List<DSSDocument> detachedDocuments)

Returns the original document from the provided cmsSignedData
Uses of DSSDocument in eu.europa.esig.dss.cades.signature

Classes in eu.europa.esig.dss.cades.signature that implement DSSDocument

Modifier and Type

Class

Description

class

CMSSignedDocument

A document composed by a CMSSignedData

Methods in eu.europa.esig.dss.cades.signature that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

CAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the CAdES Signature

DSSDocument

CAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore)

Extends all signatures within the given document, matching the provided policy in SignaturePolicyStore

DSSDocument

CAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore, String signatureId)

Adds a signaturePolicyStore to a signature with the given signatureId, if the signature policy identifier matches the policy provided within SignaturePolicyStore

DSSDocument

CAdESService.counterSignSignature(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

CAdESService.extendDocument(DSSDocument toExtendDocument, CAdESSignatureParameters parameters)

DSSDocument

CAdESService.signDocument(DSSDocument toSignDocument, CAdESSignatureParameters parameters, SignatureValue signatureValue)

Methods in eu.europa.esig.dss.cades.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

CAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the CAdES Signature

DSSDocument

CAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore)

Extends all signatures within the given document, matching the provided policy in SignaturePolicyStore

DSSDocument

CAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore, String signatureId)

Adds a signaturePolicyStore to a signature with the given signatureId, if the signature policy identifier matches the policy provided within SignaturePolicyStore

DSSDocument

CAdESService.counterSignSignature(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

CAdESService.extendDocument(DSSDocument toExtendDocument, CAdESSignatureParameters parameters)

DSSMessageDigest

CadesLevelBaselineLTATimestampExtractor.getArchiveTimestampV3MessageImprint(org.bouncycastle.cms.SignerInformation signerInformation, org.bouncycastle.asn1.cms.Attribute atsHashIndexAttribute, DSSDocument originalDocument, DigestAlgorithm digestAlgorithm)

Computes a message-imprint for an archive-time-stamp-v3

TimestampToken

CAdESService.getContentTimestamp(DSSDocument toSignDocument, CAdESSignatureParameters parameters)

ToBeSigned

CAdESService.getDataToBeCounterSigned(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters)

ToBeSigned

CAdESService.getDataToBeCounterSigned(DSSDocument signatureDocument, org.bouncycastle.cms.SignerInformation signerInfoToCounterSign, CAdESSignatureParameters parameters)

Returns a data toBeSigned for a counter signature on the given signerInfoToCounterSign

ToBeSigned

CAdESService.getDataToSign(DSSDocument toSignDocument, CAdESSignatureParameters parameters)

org.bouncycastle.cms.SignerInformation

CAdESCounterSignatureBuilder.getSignerInformationToBeCounterSigned(DSSDocument signatureDocument, CAdESCounterSignatureParameters parameters)

Returns a SignerInformation to be counter signed

DSSDocument

CAdESService.signDocument(DSSDocument toSignDocument, CAdESSignatureParameters parameters, SignatureValue signatureValue)

Constructors in eu.europa.esig.dss.cades.signature with parameters of type DSSDocument

Modifier

Constructor

Description

CAdESLevelBaselineB(DSSDocument documentToSign)

The constructor for CAdESLevelBaselineB with a documentToSign
Uses of DSSDocument in eu.europa.esig.dss.cades.validation

Methods in eu.europa.esig.dss.cades.validation that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

CAdESSignature.getOriginalDocument()

Returns the original signed document

protected DSSDocument

CAdESSignature.getSignerDocumentContent()

This method extracts a document content that was signed NOTE: Some differences are possible with PAdES

Methods in eu.europa.esig.dss.cades.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

CMSDocumentValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

Methods in eu.europa.esig.dss.cades.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

CMSDocumentValidatorFactory.create(DSSDocument document)

boolean

CMSDocumentValidator.isSupported(DSSDocument dssDocument)

boolean

CMSDocumentValidatorFactory.isSupported(DSSDocument document)

Constructors in eu.europa.esig.dss.cades.validation with parameters of type DSSDocument

Modifier

Constructor

Description

CMSDocumentValidator(DSSDocument document)

The default constructor for CMSDocumentValidator.

protected

CMSDocumentValidator(DSSDocument document, SignatureScopeFinder<CAdESSignature> signatureScopeFinder)

Creates a validator from a DSSDocument
Uses of DSSDocument in eu.europa.esig.dss.cades.validation.scope

Methods in eu.europa.esig.dss.cades.validation.scope that return DSSDocument

Modifier and Type

Method

Description

protected DSSDocument

CAdESSignatureScopeFinder.getOriginalDocument(CAdESSignature cadesSignature)

Returns original document for the given CAdES signature

Methods in eu.europa.esig.dss.cades.validation.scope with parameters of type DSSDocument

Modifier and Type

Method

Description

protected List<SignatureScope>

CAdESSignatureScopeFinder.getSignatureScopeFromOriginalDocument(CAdESSignature cadesSignature, DSSDocument originalDocument)

Returns a list of SignatureScopes from the signed document
Uses of DSSDocument in eu.europa.esig.dss.jades

Classes in eu.europa.esig.dss.jades that implement DSSDocument

Modifier and Type

Class

Description

class

HTTPHeader

The class represents an HTTP Header to be signed See ETSI TS 119 182-1 "5.2.8.2 Mechanism HttpHeaders" The class shall be used only for JAdES detached SigDMechanism.HTTP_HEADERS mechanism

class

HTTPHeaderDigest

An HTTP message body, which 'Digest' representation is being signed with 'sigD' HTTP_HEADERS mechanism

Methods in eu.europa.esig.dss.jades that return DSSDocument

Modifier and Type

Method

Description

static DSSDocument

JWSConverter.fromEtsiUWithBase64UrlToClearJsonIncorporation(DSSDocument document)

Converts unprotected content of 'etsiU' header of JAdES signatures inside a document to its clear JSON incorporation form

static DSSDocument

JWSConverter.fromEtsiUWithClearJsonToBase64UrlIncorporation(DSSDocument document)

Converts unprotected content of 'etsiU' header of JAdES signatures inside a document to its base64Url JSON incorporation form

static DSSDocument

JWSConverter.fromJWSCompactToJSONFlattenedSerialization(DSSDocument document)

Converts a JWS Compact Serialization to a JSON Flattened Serialization.

static DSSDocument

JWSConverter.fromJWSCompactToJSONSerialization(DSSDocument document)

Converts a JWS Compact Serialization to a JSON Serialization.

DSSDocument

JWSJsonSerializationGenerator.generate()

Generates the DSSDocument

DSSDocument

HTTPHeaderDigest.getMessageBodyDocument()

Returns the original HTTP Message Body Document

Methods in eu.europa.esig.dss.jades with parameters of type DSSDocument

Modifier and Type

Method

Description

static DSSDocument

JWSConverter.fromEtsiUWithBase64UrlToClearJsonIncorporation(DSSDocument document)

Converts unprotected content of 'etsiU' header of JAdES signatures inside a document to its clear JSON incorporation form

static DSSDocument

JWSConverter.fromEtsiUWithClearJsonToBase64UrlIncorporation(DSSDocument document)

Converts unprotected content of 'etsiU' header of JAdES signatures inside a document to its base64Url JSON incorporation form

static DSSDocument

JWSConverter.fromJWSCompactToJSONFlattenedSerialization(DSSDocument document)

Converts a JWS Compact Serialization to a JSON Flattened Serialization.

static DSSDocument

JWSConverter.fromJWSCompactToJSONSerialization(DSSDocument document)

Converts a JWS Compact Serialization to a JSON Serialization.

static byte[]

DSSJsonUtils.getDocumentOctets(DSSDocument document, boolean isBase64UrlEncoded)

This method returns binaries of the document to be used for payload computation, depending on the isBase64UrlEncoded parameter.

static boolean

DSSJsonUtils.isAllowedSignatureDocumentType(DSSDocument document)

Checks if the signature document has an allowed type (bytes can be extracted)

static boolean

DSSJsonUtils.isJsonDocument(DSSDocument document)

Checks if the provided document is JSON document

static String

DSSJsonUtils.toBase64Url(DSSDocument document)

Returns a base64Url encoded string

Method parameters in eu.europa.esig.dss.jades with type arguments of type DSSDocument

Modifier and Type

Method

Description

static byte[]

DSSJsonUtils.concatenateDSSDocuments(List<DSSDocument> documents, boolean isBase64UrlEncoded)

Concatenates document octets to a single byte array

static void

DSSJsonUtils.writeDocumentsDigest(List<DSSDocument> documents, boolean isBase64UrlEncoded, DSSMessageDigestCalculator digestCalculator)

Writes digest on a concatenated binaries of provided documents

Constructors in eu.europa.esig.dss.jades with parameters of type DSSDocument

Modifier

Constructor

Description

HTTPHeaderDigest(DSSDocument messageBodyDocument, DigestAlgorithm digestAlgorithm)

The default constructor

JWSCompactSerializationParser(DSSDocument document)

The default constructor

JWSJsonSerializationParser(DSSDocument document)

The default constructor for parser to extract a list of signatures and payload
Uses of DSSDocument in eu.europa.esig.dss.jades.signature

Methods in eu.europa.esig.dss.jades.signature that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

JAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as a base64Url-encoded unsigned property into the JAdES Signature

DSSDocument

JAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore, boolean base64UrlInstance)

Incorporates a Signature Policy Store as an unsigned property into the JAdES Signature

DSSDocument

JAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore, boolean base64UrlInstance)

Adds signaturePolicyStore to all signatures inside the document matching the given SignaturePolicyStore.

DSSDocument

JAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore, boolean base64UrlInstance, String signatureId)

Adds signaturePolicyStore to a signature inside the document with the given signatureId

DSSDocument

JAdESBuilder.build(SignatureValue signatureValue)

Builds a signature

DSSDocument

JAdESCompactBuilder.build(SignatureValue signatureValue)

Builds the concatenation of signed header and payload (dataTobeSigned string) in the way : BASE64URL(UTF8(JWS Protected Header)) || '.' || BASE64URL(JWS Payload)

DSSDocument

JAdESSerializationBuilder.build(SignatureValue signatureValue)

DSSDocument

JAdESCounterSignatureBuilder.buildEmbeddedCounterSignature(DSSDocument signatureDocument, DSSDocument counterSignature, JAdESCounterSignatureParameters parameters)

Embeds and returns the embedded counter signature into the original JAdES signature

DSSDocument

JAdESService.counterSignSignature(DSSDocument signatureDocument, JAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

JAdESService.extendDocument(DSSDocument toExtendDocument, JAdESSignatureParameters parameters)

DSSDocument

JAdESLevelBaselineT.extendSignatures(DSSDocument document, JAdESSignatureParameters params)

DSSDocument

JAdESCounterSignatureBuilder.getSignatureValueToBeSigned(DSSDocument signatureDocument, JAdESCounterSignatureParameters parameters)

Extract SignatureValue binaries from the provided JAdES signature

DSSDocument

JAdESService.signDocument(DSSDocument toSignDocument, JAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

JAdESService.signDocument(List<DSSDocument> toSignDocuments, JAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

JAdESService.timestamp(List<DSSDocument> toTimestampDocuments, JAdESTimestampParameters parameters)

Methods in eu.europa.esig.dss.jades.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

JAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as a base64Url-encoded unsigned property into the JAdES Signature

DSSDocument

JAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore, boolean base64UrlInstance)

Incorporates a Signature Policy Store as an unsigned property into the JAdES Signature

DSSDocument

JAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore, boolean base64UrlInstance)

Adds signaturePolicyStore to all signatures inside the document matching the given SignaturePolicyStore.

DSSDocument

JAdESSignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore, boolean base64UrlInstance, String signatureId)

Adds signaturePolicyStore to a signature inside the document with the given signatureId

DSSDocument

JAdESCounterSignatureBuilder.buildEmbeddedCounterSignature(DSSDocument signatureDocument, DSSDocument counterSignature, JAdESCounterSignatureParameters parameters)

Embeds and returns the embedded counter signature into the original JAdES signature

DSSDocument

JAdESService.counterSignSignature(DSSDocument signatureDocument, JAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

JAdESService.extendDocument(DSSDocument toExtendDocument, JAdESSignatureParameters parameters)

DSSDocument

JAdESLevelBaselineT.extendSignatures(DSSDocument document, JAdESSignatureParameters params)

TimestampToken

JAdESService.getContentTimestamp(DSSDocument toSignDocument, JAdESSignatureParameters parameters)

ToBeSigned

JAdESService.getDataToBeCounterSigned(DSSDocument signatureDocument, JAdESCounterSignatureParameters parameters)

ToBeSigned

JAdESService.getDataToSign(DSSDocument toSignDocument, JAdESSignatureParameters parameters)

DSSDocument

JAdESCounterSignatureBuilder.getSignatureValueToBeSigned(DSSDocument signatureDocument, JAdESCounterSignatureParameters parameters)

Extract SignatureValue binaries from the provided JAdES signature

DSSDocument

JAdESService.signDocument(DSSDocument toSignDocument, JAdESSignatureParameters parameters, SignatureValue signatureValue)

Method parameters in eu.europa.esig.dss.jades.signature with type arguments of type DSSDocument

Modifier and Type

Method

Description

TimestampToken

JAdESService.getContentTimestamp(List<DSSDocument> toSignDocuments, JAdESSignatureParameters parameters)

This methods allows to create a TimestampToken for a detached JAdES (with a 'sigD' parameter).

ToBeSigned

JAdESService.getDataToSign(List<DSSDocument> toSignDocuments, JAdESSignatureParameters parameters)

protected JAdESBuilder

JAdESService.getJAdESBuilder(JAdESSignatureParameters parameters, List<DSSDocument> documentsToSign)

Returns the JAdESBuilder to be used

DSSDocument

JAdESService.signDocument(List<DSSDocument> toSignDocuments, JAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

JAdESService.timestamp(List<DSSDocument> toTimestampDocuments, JAdESTimestampParameters parameters)

Constructor parameters in eu.europa.esig.dss.jades.signature with type arguments of type DSSDocument

Modifier

Constructor

Description

protected

AbstractJAdESBuilder(CertificateVerifier certificateVerifier, JAdESSignatureParameters parameters, List<DSSDocument> documentsToSign)

Default constructor

HttpHeadersPayloadBuilder(List<DSSDocument> detachedContents, boolean isTimestamp)

The default constructor

JAdESCompactBuilder(CertificateVerifier certificateVerifier, JAdESSignatureParameters parameters, List<DSSDocument> documentsToSign)

The default constructor

JAdESLevelBaselineB(CertificateVerifier certificateVerifier, JAdESSignatureParameters parameters, List<DSSDocument> documentsToSign)

The default constructor

JAdESSerializationBuilder(CertificateVerifier certificateVerifier, JAdESSignatureParameters parameters, List<DSSDocument> documentsToSign)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.jades.validation

Methods in eu.europa.esig.dss.jades.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

AbstractJWSDocumentValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

List<DSSDocument>

JAdESSignature.getOriginalDocuments()

Returns a list of original documents signed by the signature

List<DSSDocument>

JAdESSignature.getSignedDocumentsByHTTPHeaderName()

Returns a list of signed documents by the list of URIs present in 'sigD' Keeps the original order according to 'pars' dictionary content Used in HTTPHeaders detached signature mechanism

List<DSSDocument>

JAdESSignature.getSignedDocumentsForObjectIdByUriMechanism()

This method returns a list of documents for ObjectIdByUrl or ObjectIdByUriHash mechanisms Keeps the original order according to 'pars' dictionary content

Methods in eu.europa.esig.dss.jades.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

AbstractJWSDocumentValidator

JAdESDocumentValidatorFactory.create(DSSDocument document)

boolean

JAdESDocumentValidatorFactory.isSupported(DSSDocument document)

boolean

JWSCompactDocumentValidator.isSupported(DSSDocument dssDocument)

boolean

JWSSerializationDocumentValidator.isSupported(DSSDocument document)

Constructors in eu.europa.esig.dss.jades.validation with parameters of type DSSDocument

Modifier

Constructor

Description

protected

AbstractJWSDocumentValidator(DSSDocument document)

Default constructor

JWSCompactDocumentValidator(DSSDocument document)

Default constructor

JWSSerializationDocumentValidator(DSSDocument document)

Default constructor
Uses of DSSDocument in eu.europa.esig.dss.jades.validation.scope

Methods in eu.europa.esig.dss.jades.validation.scope that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

protected List<DSSDocument>

JAdESSignatureScopeFinder.getOriginalDocuments(JAdESSignature jadesSignature)

Returns original documents for the given JAdES signature

Methods in eu.europa.esig.dss.jades.validation.scope with parameters of type DSSDocument

Modifier and Type

Method

Description

protected SignatureScope

JAdESSignatureScopeFinder.getSignatureScopeFromOriginalDocument(DSSDocument originalDocument)

Returns a SignatureScope for the given originalDocument

Method parameters in eu.europa.esig.dss.jades.validation.scope with type arguments of type DSSDocument

Modifier and Type

Method

Description

protected List<SignatureScope>

JAdESSignatureScopeFinder.getSignatureScopeFromOriginalDocuments(List<DSSDocument> originalDocuments)

Extracts a SignatureScope list from a list of original documents
Uses of DSSDocument in eu.europa.esig.dss.model

Classes in eu.europa.esig.dss.model that implement DSSDocument

Modifier and Type

Class

Description

class

CommonDocument

This class implements the default methods.

class

DigestDocument

Digest representation of a DSSDocument.

class

FileDocument

Document implementation stored on file-system.

class

InMemoryDocument

In memory representation of a document

Methods in eu.europa.esig.dss.model that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

CommitmentQualifier.getContent()

Gets the content of the Commitment Qualifier

DSSDocument

SignaturePolicyStore.getSignaturePolicyContent()

Get policy store content

Methods in eu.europa.esig.dss.model with parameters of type DSSDocument

Modifier and Type

Method

Description

void

CommitmentQualifier.setContent(DSSDocument content)

Sets the content of Commitment Qualifier.

void

SignaturePolicyStore.setSignaturePolicyContent(DSSDocument signaturePolicyContent)

Set policy store content NOTE: one of signaturePolicyContent or sigPolDocLocalURI shall be used
Uses of DSSDocument in eu.europa.esig.dss.pades

Methods in eu.europa.esig.dss.pades that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

SignatureImageParameters.getImage()

Returns a DSSDocument image defined for displaying on the signature field

static DSSDocument

PAdESUtils.getOriginalPDF(PAdESSignature padesSignature)

Returns the original signed content for the padesSignature

static DSSDocument

PAdESUtils.getOriginalPDF(PdfCMSRevision pdfRevision)

Returns the original signed content for the pdfRevision

static DSSDocument

PAdESUtils.getPreviousRevision(ByteRange byteRange, Collection<PdfByteRangeDocument> revisions)

This method returns the best previous revision from revisions collection corresponding to the byteRange

static DSSDocument

PAdESUtils.getRevisionContent(DSSDocument dssDocument, ByteRange byteRange)

Returns the complete revision content according to the provided byteRange ([0]-[3])

static DSSDocument

PAdESUtils.replaceSignature(DSSDocument toBeSignedDocument, byte[] cmsSignedData, DSSResourcesHandlerBuilder resourcesHandlerBuilder)

This method replaces /Contents field value with a given cmsSignedData binaries

Methods in eu.europa.esig.dss.pades with parameters of type DSSDocument

Modifier and Type

Method

Description

static List<PdfByteRangeDocument>

PAdESUtils.extractRevisions(DSSDocument document)

Parses document and extracts all revisions based on %%EOF string

static DSSDocument

PAdESUtils.getRevisionContent(DSSDocument dssDocument, ByteRange byteRange)

Returns the complete revision content according to the provided byteRange ([0]-[3])

static byte[]

PAdESUtils.getSignatureValue(DSSDocument dssDocument, ByteRange byteRange)

Gets the SignatureValue from the dssDocument according to the byteRange Example: extracts bytes from 841 to 959.

static boolean

PAdESUtils.isPDFDocument(DSSDocument document)

Checks if the given DSSDocument represents a PDF document

static DSSDocument

PAdESUtils.replaceSignature(DSSDocument toBeSignedDocument, byte[] cmsSignedData, DSSResourcesHandlerBuilder resourcesHandlerBuilder)

This method replaces /Contents field value with a given cmsSignedData binaries

void

SignatureImageParameters.setImage(DSSDocument image)

Allows to set a custom image to display on a signature field

Constructors in eu.europa.esig.dss.pades with parameters of type DSSDocument

Modifier

Constructor

Description

DSSFileFont(DSSDocument dssDocument)

Constructor to load the font from DSSDocument

DSSFileFont(DSSDocument dssDocument, float size)

Constructor to load the font from DSSDocument with a size
Uses of DSSDocument in eu.europa.esig.dss.pades.signature

Methods in eu.europa.esig.dss.pades.signature that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

PAdESService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)

This method allows to add a new signature field to an existing pdf document

DSSDocument

PAdESService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] passwordProtection)

This method allows to add a new signature field to an encrypted pdf document

DSSDocument

PAdESService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, String passwordProtection)

Deprecated.
since DSS 5.12.

DSSDocument

PAdESService.extendDocument(DSSDocument toExtendDocument, PAdESSignatureParameters parameters)

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document)

This method adds a DSS dictionary revision to the given document without password-protection with the required validation data if needed and no VRI dictionary created.

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document, char[] passwordProtection)

This method adds a DSS dictionary revision to the given document protected by a passwordProtection with the required validation data if needed, without VRI dictionary created.

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document, char[] passwordProtection, boolean includeVRIDict)

This method adds a DSS dictionary revision to the given document protected by a passwordProtection with the required validation data if needed, and a VRI dictionary is defined.

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document, String passwordProtection)

Deprecated.
since DSS 5.12.

DSSDocument

PAdESService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

Returns a page preview with the visual signature

DSSDocument

PAdESService.previewSignatureField(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

Returns a preview of the signature field

DSSDocument

PAdESService.signDocument(DSSDocument toSignDocument, PAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

PAdESWithExternalCMSService.signDocument(DSSDocument toSignDocument, PAdESSignatureParameters parameters, DSSDocument cmsDocument)

This method embeds the provided external cmsDocument to a {code toSignDocument} within a new signature revision.

DSSDocument

PAdESService.timestamp(DSSDocument toTimestampDocument, PAdESTimestampParameters parameters)

Methods in eu.europa.esig.dss.pades.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

PAdESService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)

This method allows to add a new signature field to an existing pdf document

DSSDocument

PAdESService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] passwordProtection)

This method allows to add a new signature field to an encrypted pdf document

DSSDocument

PAdESService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, String passwordProtection)

Deprecated.
since DSS 5.12.

protected DSSMessageDigest

PAdESService.computeDocumentDigest(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

Computes digest of the document to be signed

DSSDocument

PAdESService.extendDocument(DSSDocument toExtendDocument, PAdESSignatureParameters parameters)

protected byte[]

PAdESService.generateCMSSignedData(DSSDocument toSignDocument, PAdESSignatureParameters parameters, SignatureValue signatureValue)

Generates the CMSSignedData

List<String>

PAdESService.getAvailableSignatureFields(DSSDocument document)

This method returns not signed signature-fields

List<String>

PAdESService.getAvailableSignatureFields(DSSDocument document, char[] passwordProtection)

This method returns not signed signature-fields from an encrypted document

List<String>

PAdESService.getAvailableSignatureFields(DSSDocument document, String passwordProtection)

Deprecated.
since DSS 5.12.

TimestampToken

PAdESService.getContentTimestamp(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

ToBeSigned

PAdESService.getDataToSign(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

protected String

PAdESWithExternalCMSService.getFinalDocumentName(DSSDocument originalFile, SignatureLevel level)

Generates and returns a final name for the document to be created

DSSMessageDigest

PAdESWithExternalCMSService.getMessageDigest(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

This method computes message-digest of the signature ByteRange to be used for CMS Signed Data creation

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document)

This method adds a DSS dictionary revision to the given document without password-protection with the required validation data if needed and no VRI dictionary created.

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document, char[] passwordProtection)

This method adds a DSS dictionary revision to the given document protected by a passwordProtection with the required validation data if needed, without VRI dictionary created.

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document, char[] passwordProtection, boolean includeVRIDict)

This method adds a DSS dictionary revision to the given document protected by a passwordProtection with the required validation data if needed, and a VRI dictionary is defined.

DSSDocument

PAdESExtensionService.incorporateValidationData(DSSDocument document, String passwordProtection)

Deprecated.
since DSS 5.12.

boolean

PAdESWithExternalCMSService.isValidCMSSignedData(DSSMessageDigest messageDigest, DSSDocument cms)

This method verifies if the cms is cryptographically valid

boolean

PAdESWithExternalCMSService.isValidPAdESBaselineCMSSignedData(DSSMessageDigest messageDigest, DSSDocument cms)

This method verifies if the given cms signature is compliant for PAdES format

DSSDocument

PAdESService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

Returns a page preview with the visual signature

DSSDocument

PAdESService.previewSignatureField(DSSDocument toSignDocument, PAdESSignatureParameters parameters)

Returns a preview of the signature field

DSSDocument

PAdESService.signDocument(DSSDocument toSignDocument, PAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

PAdESWithExternalCMSService.signDocument(DSSDocument toSignDocument, PAdESSignatureParameters parameters, DSSDocument cmsDocument)

This method embeds the provided external cmsDocument to a {code toSignDocument} within a new signature revision.

DSSDocument

PAdESService.timestamp(DSSDocument toTimestampDocument, PAdESTimestampParameters parameters)
Uses of DSSDocument in eu.europa.esig.dss.pades.timestamp

Methods in eu.europa.esig.dss.pades.timestamp that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

PAdESTimestampService.timestampDocument(DSSDocument document, PAdESTimestampParameters params)

Timestamp the document

Methods in eu.europa.esig.dss.pades.timestamp with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

PAdESTimestampService.timestampDocument(DSSDocument document, PAdESTimestampParameters params)

Timestamp the document
Uses of DSSDocument in eu.europa.esig.dss.pades.validation

Classes in eu.europa.esig.dss.pades.validation that implement DSSDocument

Modifier and Type

Class

Description

class

PdfByteRangeDocument

Internal representation of a PDF document.

Methods in eu.europa.esig.dss.pades.validation that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

PAdESSignature.getOriginalDocument()

protected DSSDocument

PAdESSignature.getSignerDocumentContent()

Methods in eu.europa.esig.dss.pades.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

PDFDocumentValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

Methods in eu.europa.esig.dss.pades.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

PDFDocumentValidatorFactory.create(DSSDocument document)

boolean

PDFDocumentValidator.isSupported(DSSDocument dssDocument)

boolean

PDFDocumentValidatorFactory.isSupported(DSSDocument document)

Constructors in eu.europa.esig.dss.pades.validation with parameters of type DSSDocument

Modifier

Constructor

Description

PdfByteRangeDocument(DSSDocument pdfDocument, ByteRange byteRange)

Default constructor

PDFDocumentValidator(DSSDocument document)

The default constructor for PDFDocumentValidator.
Uses of DSSDocument in eu.europa.esig.dss.pdf

Methods in eu.europa.esig.dss.pdf that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

AbstractPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion)

DSSDocument

AbstractPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd)

DSSDocument

AbstractPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, String pwd)

Deprecated.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion)

This method adds the DSS dictionary (Baseline-LT) to a document without password-protection and without VRI dictionary.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd)

This method adds the DSS dictionary (Baseline-LT) to a password-protected document without inclusion of VRI dictionary.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd, boolean includeVRIDict)

This method adds the DSS dictionary (Baseline-LT) to a password-protected document with a VRI dictionary if defined.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, String pwd)

Deprecated.
since DSS 5.12.

DSSDocument

AbstractPDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)

DSSDocument

AbstractPDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, String pwd)

Deprecated.

DSSDocument

PDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)

This method allows to add a new signature field to an existing pdf document

DSSDocument

PDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] pwd)

This method allows to add a new signature field to an existing encrypted pdf document

DSSDocument

PDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, String pwd)

Deprecated.
since DSS 5.12.

DSSDocument

PdfCMSRevision.getPreviousRevision()

Gets PDF revision preceding to the current signature revision

DSSDocument

PdfCMSRevision.getSignedData()

Gets the current signature revision

DSSDocument

PdfSignatureCache.getToBeSignedDocument()

Gets ToBeSigned document

DSSDocument

PDFSignatureService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Returns a page preview with the visual signature

DSSDocument

PDFSignatureService.previewSignatureField(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Returns a preview of the signature field

DSSDocument

AbstractPDFSignatureService.sign(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

DSSDocument

PDFSignatureService.sign(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

Signs a PDF document

protected abstract DSSDocument

AbstractPDFSignatureService.signDocument(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

This method creates a signed document from the original toSignDocument, incorporating a new revision, enveloping the provided cmsSignedData

Methods in eu.europa.esig.dss.pdf with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

AbstractPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion)

DSSDocument

AbstractPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd)

DSSDocument

AbstractPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, String pwd)

Deprecated.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion)

This method adds the DSS dictionary (Baseline-LT) to a document without password-protection and without VRI dictionary.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd)

This method adds the DSS dictionary (Baseline-LT) to a password-protected document without inclusion of VRI dictionary.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd, boolean includeVRIDict)

This method adds the DSS dictionary (Baseline-LT) to a password-protected document with a VRI dictionary if defined.

DSSDocument

PDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, String pwd)

Deprecated.
since DSS 5.12.

DSSDocument

AbstractPDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)

DSSDocument

AbstractPDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, String pwd)

Deprecated.

DSSDocument

PDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters)

This method allows to add a new signature field to an existing pdf document

DSSDocument

PDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] pwd)

This method allows to add a new signature field to an existing encrypted pdf document

DSSDocument

PDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, String pwd)

Deprecated.
since DSS 5.12.

protected void

AbstractPDFSignatureService.analyzePdfModifications(DSSDocument document, PdfCMSRevision pdfRevision, PdfDocumentReader finalRevisionReader, char[] pwd)

This method performs a modification analysis for a single given pdfRevision

void

AbstractPDFSignatureService.analyzePdfModifications(DSSDocument document, List<AdvancedSignature> signatures, char[] pwd)

void

AbstractPDFSignatureService.analyzePdfModifications(DSSDocument document, List<AdvancedSignature> signatures, String pwd)

Deprecated.

void

PDFSignatureService.analyzePdfModifications(DSSDocument document, List<AdvancedSignature> signatures, char[] pwd)

Analyze the PDF revision and try to detect any modification (shadow attacks) for signatures

void

PDFSignatureService.analyzePdfModifications(DSSDocument document, List<AdvancedSignature> signatures, String pwd)

Deprecated.
since DSS 5.12.

void

AbstractPDFSignatureService.analyzeTimestampPdfModifications(DSSDocument document, List<TimestampToken> timestamps, char[] pwd)

void

PDFSignatureService.analyzeTimestampPdfModifications(DSSDocument document, List<TimestampToken> timestamps, char[] pwd)

Analyze the PDF revision and try to detect any modification (shadow attacks) for PDf document timestamps

protected abstract DSSMessageDigest

AbstractPDFSignatureService.computeDigest(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Computes digest on to be signed data computed on the toSignDocument respectively to the given parameters

byte[]

AbstractPDFSignatureService.digest(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Deprecated.

byte[]

PDFSignatureService.digest(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Deprecated.
since 5.12.

List<String>

AbstractPDFSignatureService.getAvailableSignatureFields(DSSDocument document)

List<String>

AbstractPDFSignatureService.getAvailableSignatureFields(DSSDocument document, String pwd)

Deprecated.

List<String>

PDFSignatureService.getAvailableSignatureFields(DSSDocument document)

This method returns not signed signature-fields

List<String>

PDFSignatureService.getAvailableSignatureFields(DSSDocument document, char[] pwd)

Returns not-signed signature fields from an encrypted document

List<String>

PDFSignatureService.getAvailableSignatureFields(DSSDocument document, String pwd)

Deprecated.
since DSS 5.12.

List<PdfRevision>

AbstractPDFSignatureService.getRevisions(DSSDocument document, char[] pwd)

List<PdfRevision>

AbstractPDFSignatureService.getRevisions(DSSDocument document, String pwd)

Deprecated.

List<PdfRevision>

PDFSignatureService.getRevisions(DSSDocument document, char[] pwd)

Retrieves revisions from a PDF document

List<PdfRevision>

PDFSignatureService.getRevisions(DSSDocument document, String pwd)

Deprecated.
since DSS 5.12.

protected abstract PdfDocumentReader

AbstractPDFSignatureService.loadPdfDocumentReader(DSSDocument dssDocument, char[] passwordProtection)

Loads PdfDocumentReader instance

DSSMessageDigest

AbstractPDFSignatureService.messageDigest(DSSDocument toSignDocument, PAdESCommonParameters parameters)

DSSMessageDigest

PDFSignatureService.messageDigest(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Returns the message-digest computed on PDF signature revision's ByteRange

DSSDocument

PDFSignatureService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Returns a page preview with the visual signature

DSSDocument

PDFSignatureService.previewSignatureField(DSSDocument toSignDocument, PAdESCommonParameters parameters)

Returns a preview of the signature field

void

PdfSignatureCache.setToBeSignedDocument(DSSDocument toBeSignedDocument)

Sets ToBeSigned document

DSSDocument

AbstractPDFSignatureService.sign(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

DSSDocument

PDFSignatureService.sign(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

Signs a PDF document

protected abstract DSSDocument

AbstractPDFSignatureService.signDocument(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

This method creates a signed document from the original toSignDocument, incorporating a new revision, enveloping the provided cmsSignedData

protected boolean

AbstractPDFSignatureService.validateByteRange(ByteRange byteRange, DSSDocument document, byte[] cms)

This method verifies the validity of /ByteRange field against the extracted from /Contents field cms and the current pdf document

Constructors in eu.europa.esig.dss.pdf with parameters of type DSSDocument

Modifier

Constructor

Description

protected

PdfCMSRevision(PdfSignatureDictionary signatureDictionary, List<PdfSignatureField> signatureFields, DSSDocument signedContent, DSSDocument previousRevision, boolean coverAllOriginalBytes)

Default constructor

PdfDocTimestampRevision(PdfSignatureDictionary signatureDictionary, List<PdfSignatureField> timestampFields, DSSDocument signedContent, DSSDocument previousRevision, boolean coverCompleteRevision)

Default constructor to create PdfDocTimestampInfo

PdfSignatureRevision(PdfSignatureDictionary signatureDictionary, PdfCompositeDssDictionary compositeDssDictionary, PdfDssDict dssDictionary, List<PdfSignatureField> signatureFields, DSSDocument signedContent, DSSDocument previousRevision, boolean coverCompleteRevision)

Default constructor
Uses of DSSDocument in eu.europa.esig.dss.pdf.openpdf

Methods in eu.europa.esig.dss.pdf.openpdf that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ITextPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd, boolean includeVRIDict)

DSSDocument

ITextPDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] pwd)

DSSDocument

ITextPDFSignatureService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESCommonParameters parameters)

DSSDocument

ITextPDFSignatureService.previewSignatureField(DSSDocument toSignDocument, PAdESCommonParameters parameters)

protected DSSDocument

ITextPDFSignatureService.signDocument(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

Methods in eu.europa.esig.dss.pdf.openpdf with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

ITextPDFSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd, boolean includeVRIDict)

DSSDocument

ITextPDFSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] pwd)

protected DSSMessageDigest

ITextPDFSignatureService.computeDigest(DSSDocument toSignDocument, PAdESCommonParameters parameters)

List<String>

ITextPDFSignatureService.getAvailableSignatureFields(DSSDocument document, char[] pwd)

protected PdfDocumentReader

ITextPDFSignatureService.loadPdfDocumentReader(DSSDocument dssDocument, char[] passwordProtection)

DSSDocument

ITextPDFSignatureService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESCommonParameters parameters)

DSSDocument

ITextPDFSignatureService.previewSignatureField(DSSDocument toSignDocument, PAdESCommonParameters parameters)

protected DSSDocument

ITextPDFSignatureService.signDocument(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

Constructors in eu.europa.esig.dss.pdf.openpdf with parameters of type DSSDocument

Modifier

Constructor

Description

ITextDocumentReader(DSSDocument dssDocument)

Default constructor of the OpenPDF implementation of the Reader

ITextDocumentReader(DSSDocument dssDocument, byte[] passwordProtection)

The OpenPDF implementation of the Reader
Uses of DSSDocument in eu.europa.esig.dss.pdf.pdfbox

Methods in eu.europa.esig.dss.pdf.pdfbox that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

PdfBoxSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd, boolean includeVRIDict)

DSSDocument

PdfBoxSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] pwd)

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page)

Generates a screenshot image of the specified page for the given PDF document

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page, DSSResourcesHandler dssResourcesHandler)

Generates a screenshot image of the specified page for the given PDF document using a provided eu.europa.esig.dss.signature.resources.DSSResourcesHandler

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, int page)

Generates a screenshot image of the specified page for the given PDF document

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, String passwordProtection, int page)

Generates a screenshot image of the specified page for the given PDF document

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, String passwordProtection, int page, DSSResourcesHandler dssResourcesHandler)

Generates a screenshot image of the specified page for the given PDF document using a provided eu.europa.esig.dss.signature.resources.DSSResourcesHandler

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, char[] passwordDocument1, int pageDocument1, DSSDocument document2, char[] passwordDocument2, int pageDocument2)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, char[] passwordDocument1, int pageDocument1, DSSDocument document2, char[] passwordDocument2, int pageDocument2, DSSResourcesHandler dssResourcesHandler)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages.

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, DSSDocument document2, int page)

This method returns an image representing a subtraction result between document1 and document2 for the given page number

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, String passwordDocument1, int pageDocument1, DSSDocument document2, String passwordDocument2, int pageDocument2)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, String passwordDocument1, int pageDocument1, DSSDocument document2, String passwordDocument2, int pageDocument2, DSSResourcesHandler dssResourcesHandler)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages.

DSSDocument

PdfBoxSignatureService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESCommonParameters parameters)

DSSDocument

PdfBoxSignatureService.previewSignatureField(DSSDocument toSignDocument, PAdESCommonParameters parameters)

protected DSSDocument

PdfBoxSignatureService.signDocument(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

Methods in eu.europa.esig.dss.pdf.pdfbox with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

PdfBoxSignatureService.addDssDictionary(DSSDocument document, PdfValidationDataContainer validationDataForInclusion, char[] pwd, boolean includeVRIDict)

DSSDocument

PdfBoxSignatureService.addNewSignatureField(DSSDocument document, SignatureFieldParameters parameters, char[] pwd)

protected DSSMessageDigest

PdfBoxSignatureService.computeDigest(DSSDocument toSignDocument, PAdESCommonParameters parameters)

static BufferedImage

PdfBoxUtils.generateBufferedImageScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page)

The method generates a BufferedImage for the specified page of the document

static BufferedImage

PdfBoxUtils.generateBufferedImageScreenshot(DSSDocument pdfDocument, String passwordProtection, int page)

The method generates a BufferedImage for the specified page of the document with String password

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page)

Generates a screenshot image of the specified page for the given PDF document

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, char[] passwordProtection, int page, DSSResourcesHandler dssResourcesHandler)

Generates a screenshot image of the specified page for the given PDF document using a provided eu.europa.esig.dss.signature.resources.DSSResourcesHandler

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, int page)

Generates a screenshot image of the specified page for the given PDF document

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, String passwordProtection, int page)

Generates a screenshot image of the specified page for the given PDF document

static DSSDocument

PdfBoxUtils.generateScreenshot(DSSDocument pdfDocument, String passwordProtection, int page, DSSResourcesHandler dssResourcesHandler)

Generates a screenshot image of the specified page for the given PDF document using a provided eu.europa.esig.dss.signature.resources.DSSResourcesHandler

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, char[] passwordDocument1, int pageDocument1, DSSDocument document2, char[] passwordDocument2, int pageDocument2)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, char[] passwordDocument1, int pageDocument1, DSSDocument document2, char[] passwordDocument2, int pageDocument2, DSSResourcesHandler dssResourcesHandler)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages.

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, DSSDocument document2, int page)

This method returns an image representing a subtraction result between document1 and document2 for the given page number

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, String passwordDocument1, int pageDocument1, DSSDocument document2, String passwordDocument2, int pageDocument2)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages

static DSSDocument

PdfBoxUtils.generateSubtractionImage(DSSDocument document1, String passwordDocument1, int pageDocument1, DSSDocument document2, String passwordDocument2, int pageDocument2, DSSResourcesHandler dssResourcesHandler)

This method returns an image representing a subtraction result between document1 and document2 for the defined pages.

List<String>

PdfBoxSignatureService.getAvailableSignatureFields(DSSDocument document, char[] pwd)

protected PdfDocumentReader

PdfBoxSignatureService.loadPdfDocumentReader(DSSDocument dssDocument, char[] passwordProtection)

DSSDocument

PdfBoxSignatureService.previewPageWithVisualSignature(DSSDocument toSignDocument, PAdESCommonParameters parameters)

DSSDocument

PdfBoxSignatureService.previewSignatureField(DSSDocument toSignDocument, PAdESCommonParameters parameters)

protected DSSDocument

PdfBoxSignatureService.signDocument(DSSDocument toSignDocument, byte[] cmsSignedData, PAdESCommonParameters parameters)

Constructors in eu.europa.esig.dss.pdf.pdfbox with parameters of type DSSDocument

Modifier

Constructor

Description

PdfBoxDocumentReader(DSSDocument dssDocument)

Default constructor of the PDFBox implementation of the Reader

PdfBoxDocumentReader(DSSDocument dssDocument, String passwordProtection)

The PDFBox implementation of the Reader
Uses of DSSDocument in eu.europa.esig.dss.pdf.pdfbox.visible.defaultdrawer

Methods in eu.europa.esig.dss.pdf.pdfbox.visible.defaultdrawer with parameters of type DSSDocument

Modifier and Type

Method

Description

static BufferedImage

DefaultImageDrawerUtils.toBufferedImage(DSSDocument imageDocument)

Reads and converts the given image document to a BufferedImage
Uses of DSSDocument in eu.europa.esig.dss.pdf.visible

Methods in eu.europa.esig.dss.pdf.visible that return DSSDocument

Modifier and Type

Method

Description

static DSSDocument

ImageUtils.toDSSDocument(BufferedImage bufferedImage)

Transforms a BufferedImage to DSSDocument using in memory processing

static DSSDocument

ImageUtils.toDSSDocument(BufferedImage bufferedImage, DSSResourcesHandler dssResourcesHandler)

Transforms a BufferedImage to DSSDocument, using a provided DSSResourcesHandler

Methods in eu.europa.esig.dss.pdf.visible with parameters of type DSSDocument

Modifier and Type

Method

Description

static AnnotationBox

ImageUtils.getImageBoundaryBox(DSSDocument imageDocument)

Returns the AnnotationBox for the given image document

static ImageResolution

ImageUtils.readDisplayMetadata(DSSDocument image)

Reads image's metadata

static BufferedImage

ImageUtils.toBufferedImage(DSSDocument imageDocument)

Reads the image document and returns a BufferedImage
Uses of DSSDocument in eu.europa.esig.dss.pdfa

Methods in eu.europa.esig.dss.pdfa with parameters of type DSSDocument

Modifier and Type

Method

Description

PDFAValidationResult

PDFAStructureValidator.validate(DSSDocument signedDocument)

This method validates a PDF/A structure for the given PDF document
Uses of DSSDocument in eu.europa.esig.dss.pdfa.validation

Methods in eu.europa.esig.dss.pdfa.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

PDFADocumentValidatorFactory.create(DSSDocument document)

boolean

PDFADocumentValidatorFactory.isSupported(DSSDocument document)

Constructors in eu.europa.esig.dss.pdfa.validation with parameters of type DSSDocument

Modifier

Constructor

Description

PDFADocumentValidator(DSSDocument document)

The default constructor for PDFADocumentValidator.
Uses of DSSDocument in eu.europa.esig.dss.service.http.commons

Methods in eu.europa.esig.dss.service.http.commons that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

FileCacheDataLoader.getDocument(String url)

Methods in eu.europa.esig.dss.service.http.commons with parameters of type DSSDocument

Modifier and Type

Method

Description

void

CommonsDataLoader.setSslKeystore(DSSDocument sslKeyStore)

Sets the SSL KeyStore

void

CommonsDataLoader.setSslTruststore(DSSDocument sslTrustStore)

Sets the SSL trust store NOTE: different from KeyStore!
Uses of DSSDocument in eu.europa.esig.dss.signature

Methods in eu.europa.esig.dss.signature that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

CounterSignatureService.counterSignSignature(DSSDocument signatureDocument, CSP parameters, SignatureValue signatureValue)

Counter-signs the signatureDocument with the provided signatureValue.

DSSDocument

DocumentSignatureService.extendDocument(DSSDocument toExtendDocument, SP parameters)

Extends the level of the signatures in the toExtendDocument

DSSDocument

MultipleDocumentsSignatureService.extendDocument(DSSDocument toExtendDocument, SP parameters)

Extends the level of the signatures in the toExtendDocument

DSSDocument

SignatureExtension.extendSignatures(DSSDocument document, SP params)

Extends the level of the signatures contained in a document.

DSSDocument

DocumentSignatureService.signDocument(DSSDocument toSignDocument, SP parameters, SignatureValue signatureValue)

Signs the toSignDocument with the provided signatureValue.

DSSDocument

MultipleDocumentsSignatureService.signDocument(List<DSSDocument> toSignDocuments, SP parameters, SignatureValue signatureValue)

Signs the toSignDocuments with the provided signatureValue.

DSSDocument

AbstractSignatureService.timestamp(DSSDocument toTimestampDocument, TP parameters)

DSSDocument

DocumentSignatureService.timestamp(DSSDocument toTimestampDocument, TP parameters)

This method allows to add a timestamp to an unsigned document

DSSDocument

MultipleDocumentsSignatureService.timestamp(List<DSSDocument> toTimestampDocuments, TP parameters)

Timestamps the toSignDocuments with the provided signatureValue.

Methods in eu.europa.esig.dss.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

CounterSignatureService.counterSignSignature(DSSDocument signatureDocument, CSP parameters, SignatureValue signatureValue)

Counter-signs the signatureDocument with the provided signatureValue.

DSSDocument

DocumentSignatureService.extendDocument(DSSDocument toExtendDocument, SP parameters)

Extends the level of the signatures in the toExtendDocument

DSSDocument

MultipleDocumentsSignatureService.extendDocument(DSSDocument toExtendDocument, SP parameters)

Extends the level of the signatures in the toExtendDocument

DSSDocument

SignatureExtension.extendSignatures(DSSDocument document, SP params)

Extends the level of the signatures contained in a document.

TimestampToken

DocumentSignatureService.getContentTimestamp(DSSDocument toSignDocument, SP parameters)

This method allows to compute a content-timestamp (which is added in the signed properties)

ToBeSigned

CounterSignatureService.getDataToBeCounterSigned(DSSDocument signatureDocument, CSP parameters)

Retrieves the bytes of the data that need to be counter-signed from signatureDocument.

ToBeSigned

DocumentSignatureService.getDataToSign(DSSDocument toSignDocument, SP parameters)

Retrieves the bytes of the data that need to be signed based on the toSignDocument and parameters.

protected String

AbstractSignatureService.getFinalDocumentName(DSSDocument originalFile, SigningOperation operation, SignatureLevel level, MimeType containerMimeType)

Generates and returns a final name for the document to create

protected String

AbstractSignatureService.getFinalDocumentName(DSSDocument originalFile, SigningOperation operation, SignatureLevel level, SignaturePackaging packaging, MimeType containerMimeType)

Generates and returns a final name for the document to create

protected String

AbstractSignatureService.getFinalFileName(DSSDocument originalFile, SigningOperation operation)

Returns the final name for the document to create

protected String

AbstractSignatureService.getFinalFileName(DSSDocument originalFile, SigningOperation operation, SignatureLevel level)

Returns the final name for the document to create

protected String

AbstractSignatureService.getFinalFileName(DSSDocument originalFile, SigningOperation operation, SignatureLevel level, SignaturePackaging packaging)

Returns the final name for the document to create

DSSDocument

DocumentSignatureService.signDocument(DSSDocument toSignDocument, SP parameters, SignatureValue signatureValue)

Signs the toSignDocument with the provided signatureValue.

DSSDocument

AbstractSignatureService.timestamp(DSSDocument toTimestampDocument, TP parameters)

DSSDocument

DocumentSignatureService.timestamp(DSSDocument toTimestampDocument, TP parameters)

This method allows to add a timestamp to an unsigned document

Method parameters in eu.europa.esig.dss.signature with type arguments of type DSSDocument

Modifier and Type

Method

Description

TimestampToken

MultipleDocumentsSignatureService.getContentTimestamp(List<DSSDocument> toSignDocuments, SP parameters)

Creates a content-timestamp attribute (to be include in the signed-data)

ToBeSigned

MultipleDocumentsSignatureService.getDataToSign(List<DSSDocument> toSignDocuments, SP parameters)

Retrieves the bytes of the data that need to be signed based on the toSignDocuments and parameters.

DSSDocument

MultipleDocumentsSignatureService.signDocument(List<DSSDocument> toSignDocuments, SP parameters, SignatureValue signatureValue)

Signs the toSignDocuments with the provided signatureValue.

DSSDocument

MultipleDocumentsSignatureService.timestamp(List<DSSDocument> toTimestampDocuments, TP parameters)

Timestamps the toSignDocuments with the provided signatureValue.
Uses of DSSDocument in eu.europa.esig.dss.signature.resources

Methods in eu.europa.esig.dss.signature.resources that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

DSSResourcesHandler.writeToDSSDocument()

This method creates a new DSSDocument representing a signed document, based on the created OutputStream.

DSSDocument

InMemoryResourcesHandler.writeToDSSDocument()

DSSDocument

TempFileResourcesHandler.writeToDSSDocument()
Uses of DSSDocument in eu.europa.esig.dss.spi

Methods in eu.europa.esig.dss.spi that return DSSDocument

Modifier and Type

Method

Description

static DSSDocument

DSSUtils.getDocumentWithLastName(List<DSSDocument> documents)

Returns the last document in the alphabetical ascendant order

static DSSDocument

DSSUtils.getDocumentWithName(List<DSSDocument> documents, String fileName)

Returns a document with the given fileName from the list of documents, when present

static DSSDocument

DSSUtils.splitDocument(DSSDocument origin, int start, int end)

This method create a new document from a sub-part of another document

Methods in eu.europa.esig.dss.spi with parameters of type DSSDocument

Modifier and Type

Method

Description

static byte[]

DSSUtils.digest(DigestAlgorithm digestAlgorithm, DSSDocument document)

Computes the digests for the document

static Digest

DSSUtils.getDigest(DigestAlgorithm digestAlgo, DSSDocument dssDocument)

Returns Digest of the dssDocument

static long

DSSUtils.getFileByteSize(DSSDocument dssDocument)

Returns byte size of the given document

static boolean

DSSUtils.isEmpty(DSSDocument document)

This method verifies if the document is empty (does not have body)

static boolean

DSSUtils.isTimestampToken(DSSDocument document)

Checks if the document contains a TimeStampToken

static long

DSSUtils.readAvailableBytes(DSSDocument dssDocument, byte[] b)

Read the requested number of bytes from DSSDocument according to the size of the provided byte[] buffer and validates success of the operation

static byte

DSSUtils.readFirstByte(DSSDocument dssDocument)

Reads the first byte from the DSSDocument

static DSSDocument

DSSUtils.splitDocument(DSSDocument origin, int start, int end)

This method create a new document from a sub-part of another document

static boolean

DSSUtils.startsWithBytes(DSSDocument dssDocument, byte[] preamble)

Reads first preamble.length bytes of the dssDocument and compares them with preamble

static byte[]

DSSUtils.toByteArray(DSSDocument document)

Get the contents of an DSSDocument as a byte[].

static org.bouncycastle.cms.CMSSignedData

DSSUtils.toCMSSignedData(DSSDocument document)

Gets CMSSignedData from the document bytes

Method parameters in eu.europa.esig.dss.spi with type arguments of type DSSDocument

Modifier and Type

Method

Description

static List<String>

DSSUtils.getDocumentNames(List<DSSDocument> dssDocuments)

Returns a list of document names from the given document list

static DSSDocument

DSSUtils.getDocumentWithLastName(List<DSSDocument> documents)

Returns the last document in the alphabetical ascendant order

static DSSDocument

DSSUtils.getDocumentWithName(List<DSSDocument> documents, String fileName)

Returns a document with the given fileName from the list of documents, when present
Uses of DSSDocument in eu.europa.esig.dss.spi.client.http

Methods in eu.europa.esig.dss.spi.client.http that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

DSSFileLoader.getDocument(String url)

Returns DSSDocument from the provided url
Uses of DSSDocument in eu.europa.esig.dss.spi.x509.revocation.crl

Constructors in eu.europa.esig.dss.spi.x509.revocation.crl with parameters of type DSSDocument

Modifier

Constructor

Description

ExternalResourcesCRLSource(DSSDocument... dssDocuments)

This constructor allows building of a CRL source from an array of DSSDocuments.
Uses of DSSDocument in eu.europa.esig.dss.spi.x509.revocation.ocsp

Constructors in eu.europa.esig.dss.spi.x509.revocation.ocsp with parameters of type DSSDocument

Modifier

Constructor

Description

ExternalResourcesOCSPSource(DSSDocument... dssDocuments)

This constructor loads the OCSP responses from an array of DSSDocuments.
Uses of DSSDocument in eu.europa.esig.dss.tsl.download

Methods in eu.europa.esig.dss.tsl.download that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

XmlDownloadResult.getDSSDocument()

Gets the downloaded document

Constructors in eu.europa.esig.dss.tsl.download with parameters of type DSSDocument

Modifier

Constructor

Description

XmlDownloadResult(DSSDocument dssDocument, Digest digest)

Default constructor
Uses of DSSDocument in eu.europa.esig.dss.tsl.parsing

Constructors in eu.europa.esig.dss.tsl.parsing with parameters of type DSSDocument

Modifier

Constructor

Description

protected

AbstractParsingTask(DSSDocument document)

Default constructor

LOTLParsingTask(DSSDocument document, LOTLSource lotlSource)

The default constructor

TLParsingTask(DSSDocument document, TLSource tlSource)

The default constructor
Uses of DSSDocument in eu.europa.esig.dss.tsl.runnable

Methods in eu.europa.esig.dss.tsl.runnable that return DSSDocument

Modifier and Type

Method

Description

protected DSSDocument

AbstractAnalysis.download(String url)

Downloads the document by url

DSSDocument

PivotProcessingResult.getPivot()

Gets the pivot document

Methods in eu.europa.esig.dss.tsl.runnable with parameters of type DSSDocument

Modifier and Type

Method

Description

protected abstract AbstractParsingTask<?>

AbstractAnalysis.getParsingTask(DSSDocument document)

Returns the corresponding parsing task for the source on the given document

protected AbstractParsingTask<?>

LOTLAnalysis.getParsingTask(DSSDocument document)

protected AbstractParsingTask<?>

PivotProcessing.getParsingTask(DSSDocument document)

protected AbstractParsingTask<?>

TLAnalysis.getParsingTask(DSSDocument document)

protected TLValidatorTask

AbstractAnalysis.getValidationTask(DSSDocument document, CertificateSource certificateSource)

Returns the corresponding validation task for the source on the given document using the provided certificate source

protected void

AbstractAnalysis.parsing(DSSDocument document)

Parses the document

protected void

AbstractAnalysis.validation(DSSDocument document, CertificateSource certificateSource)

Validates the document

Constructors in eu.europa.esig.dss.tsl.runnable with parameters of type DSSDocument

Modifier

Constructor

Description

PivotProcessingResult(DSSDocument pivot, CertificateSource certificateSource, String lotlLocation)

Default constructor
Uses of DSSDocument in eu.europa.esig.dss.tsl.validation

Constructors in eu.europa.esig.dss.tsl.validation with parameters of type DSSDocument

Modifier

Constructor

Description

TLValidatorTask(DSSDocument trustedList, CertificateSource certificateSource)

Constructor used to instantiate a validator for a trusted list
Uses of DSSDocument in eu.europa.esig.dss.validation

Fields in eu.europa.esig.dss.validation declared as DSSDocument

Modifier and Type

Field

Description

protected DSSDocument

SignedDocumentValidator.document

The document to be validated (with the signature(s) or timestamp(s))

protected DSSDocument

SignedDocumentDiagnosticDataBuilder.signedDocument

The signed document

Fields in eu.europa.esig.dss.validation with type parameters of type DSSDocument

Modifier and Type

Field

Description

protected List<DSSDocument>

SignedDocumentValidator.containerContents

In case of an ASiC signature this List of container documents.

protected List<DSSDocument>

DefaultAdvancedSignature.detachedContents

In case of a detached signature this is the signed document.

protected List<DSSDocument>

SignedDocumentValidator.detachedContents

In case of a detached signature this List contains the signed documents.

Methods in eu.europa.esig.dss.validation that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

ManifestFile.getDocument()

Gets the DSSDocument representing the manifest

DSSDocument

SignaturePolicy.getPolicyContent()

Returns a DSSDocument with the signature policy content

DSSDocument

SignaturePolicyProvider.getSignaturePolicy(String policyId, String url)

Gets signature policy by all available ways (id and uri)

DSSDocument

SignaturePolicyProvider.getSignaturePolicyById(String policyId)

Gets a signature policy document with the corresponding policyId from signaturePoliciesById map

DSSDocument

SignaturePolicyProvider.getSignaturePolicyByUrl(String url)

Gets a signature policy document with the corresponding url from signaturePoliciesByUrl map, if not found, retrieved the data from url with dataLoader

Methods in eu.europa.esig.dss.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

AdvancedSignature.getContainerContents()

Returns container's content

List<DSSDocument>

DefaultAdvancedSignature.getContainerContents()

List<DSSDocument>

AdvancedSignature.getDetachedContents()

Returns detached contents

List<DSSDocument>

DefaultAdvancedSignature.getDetachedContents()

List<DSSDocument>

DocumentValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

This method returns the signed document(s) without their signature(s)

List<DSSDocument>

DocumentValidator.getOriginalDocuments(String signatureId)

This method returns the signed document(s) without their signature(s)

List<DSSDocument>

SignedDocumentValidator.getOriginalDocuments(String signatureId)

Methods in eu.europa.esig.dss.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

DocumentValidatorFactory.create(DSSDocument document)

This method instantiates a DocumentValidator with the given document

SignedDocumentDiagnosticDataBuilder

SignedDocumentDiagnosticDataBuilder.document(DSSDocument signedDocument)

This method allows to set the document which is analysed

static SignedDocumentValidator

SignedDocumentValidator.fromDocument(DSSDocument dssDocument)

This method guesses the document format and returns an appropriate document validator.

boolean

DocumentValidatorFactory.isSupported(DSSDocument document)

This method tests if the current implementation of DocumentValidator supports the given document

abstract boolean

SignedDocumentValidator.isSupported(DSSDocument dssDocument)

Checks if the document is supported by the current validator

void

ManifestFile.setDocument(DSSDocument document)

Sets the manifest document

void

SignaturePolicy.setPolicyContent(DSSDocument policyContent)

Sets policy document content

Reports

DocumentValidator.validateDocument(DSSDocument policyDocument)

Validates the document and all its signatures.

Reports

SignedDocumentValidator.validateDocument(DSSDocument policyDocument)

Method parameters in eu.europa.esig.dss.validation with type arguments of type DSSDocument

Modifier and Type

Method

Description

void

AdvancedSignature.setContainerContents(List<DSSDocument> containerContents)

This method allows to set the archive container contents in the case of ASiC-S signature.

void

DefaultAdvancedSignature.setContainerContents(List<DSSDocument> containerContents)

void

DocumentValidator.setContainerContents(List<DSSDocument> archiveContents)

Sets the List of DSSDocument containing the original container content for ASiC-S signatures.

void

SignedDocumentValidator.setContainerContents(List<DSSDocument> containerContents)

void

AdvancedSignature.setDetachedContents(List<DSSDocument> detachedContents)

This method allows to set the signed contents in the case of the detached signature.

void

DefaultAdvancedSignature.setDetachedContents(List<DSSDocument> detachedContents)

void

DocumentValidator.setDetachedContents(List<DSSDocument> detachedContent)

Sets the List of DSSDocument containing the original contents to sign, for detached signature scenarios.

void

SignedDocumentValidator.setDetachedContents(List<DSSDocument> detachedContents)

void

SignaturePolicyProvider.setSignaturePoliciesById(Map<String,DSSDocument> signaturePoliciesById)

Sets the map of signature policy documents to retrieve by IDs

void

SignaturePolicyProvider.setSignaturePoliciesByUrl(Map<String,DSSDocument> signaturePoliciesByUrl)

Sets the map of signature policy documents to retrieve by URLs
Uses of DSSDocument in eu.europa.esig.dss.validation.policy

Methods in eu.europa.esig.dss.validation.policy with parameters of type DSSDocument

Modifier and Type

Method

Description

Digest

AbstractSignaturePolicyValidator.getComputedDigest(DSSDocument policyDocument, DigestAlgorithm digestAlgorithm)

Digest

BasicASNSignaturePolicyValidator.getComputedDigest(DSSDocument policyDocument, DigestAlgorithm digestAlgorithm)

Digest

SignaturePolicyValidator.getComputedDigest(DSSDocument policyDocument, DigestAlgorithm digestAlgorithm)

Returns Digest on the computed SignaturePolicy's content

Digest

ZeroHashSignaturePolicyValidator.getComputedDigest(DSSDocument policyDocument, DigestAlgorithm digestAlgorithm)
Uses of DSSDocument in eu.europa.esig.dss.validation.scope

Fields in eu.europa.esig.dss.validation.scope declared as DSSDocument

Modifier and Type

Field

Description

protected DSSDocument

DetachedTimestampScopeFinder.timestampedData

The data used to for message-imprint computation of a timestamp token

Methods in eu.europa.esig.dss.validation.scope with parameters of type DSSDocument

Modifier and Type

Method

Description

protected Digest

AbstractSignatureScopeFinder.getDigest(DSSDocument document)

Gets digest of a document

protected List<SignatureScope>

DetachedTimestampScopeFinder.getTimestampSignatureScopeForDocument(DSSDocument document)

Returns a timestamped SignatureScope for the given document

void

DetachedTimestampScopeFinder.setTimestampedData(DSSDocument timestampedData)

Sets the timestamped data
Uses of DSSDocument in eu.europa.esig.dss.validation.timestamp

Methods in eu.europa.esig.dss.validation.timestamp that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

DetachedTimestampValidator.getTimestampedData()

DSSDocument

TimestampValidator.getTimestampedData()

Returns the timestamped data

Methods in eu.europa.esig.dss.validation.timestamp that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

DetachedTimestampValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

List<DSSDocument>

DetachedTimestampValidator.getOriginalDocuments(String signatureId)

Methods in eu.europa.esig.dss.validation.timestamp with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

DetachedTimestampValidatorFactory.create(DSSDocument document)

boolean

DetachedTimestampValidator.isSupported(DSSDocument dssDocument)

boolean

DetachedTimestampValidatorFactory.isSupported(DSSDocument document)

boolean

TimestampToken.matchData(DSSDocument timestampedData)

Checks if the TimeStampToken matches the signed data.

boolean

TimestampToken.matchData(DSSDocument timestampedData, boolean suppressMatchWarnings)

Checks if the TimeStampToken matches the signed data.

void

DetachedTimestampValidator.setTimestampedData(DSSDocument document)

Sets the data that has been timestamped

Constructors in eu.europa.esig.dss.validation.timestamp with parameters of type DSSDocument

Modifier

Constructor

Description

DetachedTimestampValidator(DSSDocument timestampFile)

The default constructor

DetachedTimestampValidator(DSSDocument timestampFile, TimestampType timestampType)

The default constructor with a type
Uses of DSSDocument in eu.europa.esig.dss.ws.converter

Methods in eu.europa.esig.dss.ws.converter that return DSSDocument

Modifier and Type

Method

Description

static DSSDocument

RemoteDocumentConverter.toDSSDocument(RemoteDocument remoteDocument)

Converts the given RemoteDocument to a DSSDocument

Methods in eu.europa.esig.dss.ws.converter that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

static List<DSSDocument>

RemoteDocumentConverter.toDSSDocuments(List<RemoteDocument> remoteDocuments)

Converts the given list of remoteDocuments to a list of DSSDocuments

Methods in eu.europa.esig.dss.ws.converter with parameters of type DSSDocument

Modifier and Type

Method

Description

static RemoteDocument

RemoteDocumentConverter.toRemoteDocument(DSSDocument originalDocument)

Converts the given DSSDocument to a RemoteDocument

Method parameters in eu.europa.esig.dss.ws.converter with type arguments of type DSSDocument

Modifier and Type

Method

Description

static List<RemoteDocument>

RemoteDocumentConverter.toRemoteDocuments(List<DSSDocument> originalDocuments)

Converts the given list of originalDocuments to a list of RemoteDocuments
Uses of DSSDocument in eu.europa.esig.dss.xades

Methods in eu.europa.esig.dss.xades that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

DSSObject.getContent()

Gets the content of the ds:Object element to be created

DSSDocument

SignatureBuilder.signDocument(byte[] signatureValue)

Signs a document

DSSDocument

SignatureProfile.signDocument(DSSDocument toSignDocument, XAdESSignatureParameters parameters, byte[] signatureValue)

Creates a signature of the defines profile

Methods in eu.europa.esig.dss.xades that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

static List<DSSDocument>

XAdESSignatureUtils.getSignerDocuments(XAdESSignature signature)

Returns list of original signed documents

Methods in eu.europa.esig.dss.xades with parameters of type DSSDocument

Modifier and Type

Method

Description

static byte[]

DSSXMLUtils.applyTransforms(DSSDocument document, List<DSSTransform> transforms)

Applies transforms on document content and returns the byte array to be used for a digest computation NOTE: returns the original document binaries, if the list of transforms is empty.

static boolean

DSSXMLUtils.isDuplicateIdsDetected(DSSDocument doc)

This method is used to detect duplicate id values

void

DSSObject.setContent(DSSDocument content)

Sets the content of ds:Object element to be created Can be XML or any other format (e.g.

DSSDocument

SignatureProfile.signDocument(DSSDocument toSignDocument, XAdESSignatureParameters parameters, byte[] signatureValue)

Creates a signature of the defines profile

Constructors in eu.europa.esig.dss.xades with parameters of type DSSDocument

Modifier

Constructor

Description

TrustedListSignatureParametersBuilder(CertificateToken signingCertificate, DSSDocument tlXmlDocument)

The constructor to build Signature Parameters for a Trusted List signing with respect to ETSI TS 119 612
Uses of DSSDocument in eu.europa.esig.dss.xades.reference

Methods in eu.europa.esig.dss.xades.reference that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

DSSReference.getContents()

Gets the original referenced document content

DSSDocument

ReferenceProcessor.getReferenceOutput(DSSReference reference)

Returns an output content after processing the given DSSReference

Methods in eu.europa.esig.dss.xades.reference with parameters of type DSSDocument

Modifier and Type

Method

Description

void

DSSReference.setContents(DSSDocument contents)

Sets the original referenced document content

Constructor parameters in eu.europa.esig.dss.xades.reference with type arguments of type DSSDocument

Modifier

Constructor

Description

ReferenceBuilder(List<DSSDocument> documents, DigestAlgorithm digestAlgorithm, ReferenceIdProvider referenceIdProvider)

The default constructor for a detached references creation

ReferenceBuilder(List<DSSDocument> documents, XAdESSignatureParameters xadesSignatureParameters, ReferenceIdProvider referenceIdProvider)

The default constructor for a signature references creation
Uses of DSSDocument in eu.europa.esig.dss.xades.signature

Fields in eu.europa.esig.dss.xades.signature declared as DSSDocument

Modifier and Type

Field

Description

protected DSSDocument

XAdESSignatureBuilder.document

This is the reference to the original document to sign

Methods in eu.europa.esig.dss.xades.signature that return DSSDocument

Modifier and Type

Method

Description

DSSDocument

SignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore)

Adds a signaturePolicyStore to all signatures inside the document, matching the incorporated signature policy

DSSDocument

SignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore, String signatureId)

Adds a signaturePolicyStore to a signature with the given signatureId, if the signature policy identifier matches the policy provided within SignaturePolicyStore

DSSDocument

XAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the XAdES Signature

DSSDocument

ManifestBuilder.build()

Builds the Manifest

DSSDocument

CounterSignatureBuilder.buildEmbeddedCounterSignature(DSSDocument signatureDocument, DSSDocument counterSignature, XAdESCounterSignatureParameters parameters)

Embeds and returns the embedded counter signature into the UnsignedProperties of original XAdES signature

DSSDocument

XAdESService.counterSignSignature(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

protected DSSDocument

XAdESBuilder.createXmlDocument()

Creates DSSDocument from the current documentDom

DSSDocument

XAdESService.extendDocument(DSSDocument toExtendDocument, XAdESSignatureParameters parameters)

DSSDocument

XAdESLevelBaselineT.extendSignatures(DSSDocument dssDocument, XAdESSignatureParameters params)

DSSDocument

CounterSignatureBuilder.getCanonicalizedSignatureValue(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters)

Extract a canonicalized SignatureValue element from the provided XAdES signature

DSSDocument

XAdESLevelBaselineB.signDocument(DSSDocument document, XAdESSignatureParameters parameters, byte[] signatureValue)

Adds the signature value to the signature.

DSSDocument

XAdESService.signDocument(DSSDocument toSignDocument, XAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

XAdESService.signDocument(List<DSSDocument> toSignDocuments, XAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

XAdESSignatureBuilder.signDocument(byte[] signatureValue)

Adds signature value to the signature and returns XML signature (InMemoryDocument)

DSSDocument

XAdESService.timestamp(List<DSSDocument> toTimestampDocuments, XAdESTimestampParameters parameters)

Methods in eu.europa.esig.dss.xades.signature with parameters of type DSSDocument

Modifier and Type

Method

Description

DSSDocument

SignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore)

Adds a signaturePolicyStore to all signatures inside the document, matching the incorporated signature policy

DSSDocument

SignaturePolicyStoreBuilder.addSignaturePolicyStore(DSSDocument signatureDocument, SignaturePolicyStore signaturePolicyStore, String signatureId)

Adds a signaturePolicyStore to a signature with the given signatureId, if the signature policy identifier matches the policy provided within SignaturePolicyStore

DSSDocument

XAdESService.addSignaturePolicyStore(DSSDocument document, SignaturePolicyStore signaturePolicyStore)

Incorporates a Signature Policy Store as an unsigned property into the XAdES Signature

TimestampToken

AllDataObjectsTimeStampBuilder.build(DSSDocument document)

Builds a message-imprint from the given document and generates a timestamp

DSSReference

CounterSignatureBuilder.buildCounterSignatureDSSReference(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters)

The method builds a DSSReference for a SignatureValue to counter sign

DSSDocument

CounterSignatureBuilder.buildEmbeddedCounterSignature(DSSDocument signatureDocument, DSSDocument counterSignature, XAdESCounterSignatureParameters parameters)

Embeds and returns the embedded counter signature into the UnsignedProperties of original XAdES signature

DSSDocument

XAdESService.counterSignSignature(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

XAdESService.extendDocument(DSSDocument toExtendDocument, XAdESSignatureParameters parameters)

DSSDocument

XAdESLevelBaselineT.extendSignatures(DSSDocument dssDocument, XAdESSignatureParameters params)

DSSDocument

CounterSignatureBuilder.getCanonicalizedSignatureValue(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters)

Extract a canonicalized SignatureValue element from the provided XAdES signature

TimestampToken

XAdESService.getContentTimestamp(DSSDocument toSignDocument, XAdESSignatureParameters parameters)

ToBeSigned

XAdESService.getDataToBeCounterSigned(DSSDocument signatureDocument, XAdESCounterSignatureParameters parameters)

byte[]

XAdESLevelBaselineB.getDataToSign(DSSDocument dssDocument, XAdESSignatureParameters parameters)

Returns the canonicalized ds:SignedInfo XML segment under the form of InputStream

ToBeSigned

XAdESService.getDataToSign(DSSDocument toSignDocument, XAdESSignatureParameters parameters)

static XAdESSignatureBuilder

XAdESSignatureBuilder.getSignatureBuilder(XAdESSignatureParameters params, DSSDocument document, CertificateVerifier certificateVerifier)

Creates the signature according to the packaging

DSSDocument

XAdESLevelBaselineB.signDocument(DSSDocument document, XAdESSignatureParameters parameters, byte[] signatureValue)

Adds the signature value to the signature.

DSSDocument

XAdESService.signDocument(DSSDocument toSignDocument, XAdESSignatureParameters parameters, SignatureValue signatureValue)

Method parameters in eu.europa.esig.dss.xades.signature with type arguments of type DSSDocument

Modifier and Type

Method

Description

TimestampToken

AllDataObjectsTimeStampBuilder.build(List<DSSDocument> documents)

Timestamps the list of documents

TimestampToken

XAdESService.getContentTimestamp(List<DSSDocument> toSignDocuments, XAdESSignatureParameters parameters)

ToBeSigned

XAdESService.getDataToSign(List<DSSDocument> toSignDocuments, XAdESSignatureParameters parameters)

DSSDocument

XAdESService.signDocument(List<DSSDocument> toSignDocuments, XAdESSignatureParameters parameters, SignatureValue signatureValue)

DSSDocument

XAdESService.timestamp(List<DSSDocument> toTimestampDocuments, XAdESTimestampParameters parameters)

Constructors in eu.europa.esig.dss.xades.signature with parameters of type DSSDocument

Modifier

Constructor

Description

protected

XAdESSignatureBuilder(XAdESSignatureParameters params, DSSDocument document, CertificateVerifier certificateVerifier)

The default constructor for SignatureBuilder.

protected

XPathPlacementSignatureBuilder(XAdESSignatureParameters params, DSSDocument document, CertificateVerifier certificateVerifier)

The default constructor for SignatureBuilder.

Constructor parameters in eu.europa.esig.dss.xades.signature with type arguments of type DSSDocument

Modifier

Constructor

Description

ManifestBuilder(DigestAlgorithm digestAlgorithm, List<DSSDocument> documents)

Constructor for the builder (the Id of the Manifest tag will be equals to "manifest")

ManifestBuilder(String manifestId, DigestAlgorithm digestAlgorithm, List<DSSDocument> documents)

Constructor for the builder

ManifestBuilder(String manifestId, DigestAlgorithm digestAlgorithm, List<DSSDocument> documents, DSSNamespace xmldsigNamespace)

Constructor for the builder
Uses of DSSDocument in eu.europa.esig.dss.xades.validation

Methods in eu.europa.esig.dss.xades.validation that return types with arguments of type DSSDocument

Modifier and Type

Method

Description

List<DSSDocument>

XMLDocumentValidator.getOriginalDocuments(AdvancedSignature advancedSignature)

Methods in eu.europa.esig.dss.xades.validation with parameters of type DSSDocument

Modifier and Type

Method

Description

SignedDocumentValidator

XMLDocumentValidatorFactory.create(DSSDocument document)

boolean

XMLDocumentValidator.isSupported(DSSDocument dssDocument)

boolean

XMLDocumentValidatorFactory.isSupported(DSSDocument document)

Constructors in eu.europa.esig.dss.xades.validation with parameters of type DSSDocument

Modifier

Constructor

Description

CounterSignatureResolver(DSSDocument document)

Default constructor

XMLDocumentValidator(DSSDocument dssDocument)

The default constructor for XMLDocumentValidator.

Constructor parameters in eu.europa.esig.dss.xades.validation with type arguments of type DSSDocument

Modifier

Constructor

Description

DetachedSignatureResolver(List<DSSDocument> documents, DigestAlgorithm digestAlgorithm)

Default constructor

ManifestValidator(org.apache.xml.security.signature.Manifest manifest, List<DSSDocument> detachedContents)

The constructor with instantiated org.apache.xml.security.signature.Manifest and detached contents

ManifestValidator(Element manifestElement, List<DSSDocument> detachedContents)

Default constructor
Uses of DSSDocument in eu.europa.esig.dss.xades.validation.policy

Methods in eu.europa.esig.dss.xades.validation.policy with parameters of type DSSDocument

Modifier and Type

Method

Description

Digest

XMLSignaturePolicyValidator.getDigestAfterTransforms(DSSDocument policyDocument, DigestAlgorithm digestAlgorithm, Element transformsElement)

Computes Digests after processing of given transformsElement

Uses of Interfaceeu.europa.esig.dss.model.DSSDocument

Uses of DSSDocument in eu.europa.esig.dss

Uses of DSSDocument in eu.europa.esig.dss.asic.cades

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.merge

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature.asice

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature.asics

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.signature.manifest

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.timestamp

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.validation

Uses of DSSDocument in eu.europa.esig.dss.asic.cades.validation.scope

Uses of DSSDocument in eu.europa.esig.dss.asic.common

Uses of DSSDocument in eu.europa.esig.dss.asic.common.merge

Uses of DSSDocument in eu.europa.esig.dss.asic.common.signature

Uses of DSSDocument in eu.europa.esig.dss.asic.common.validation

Uses of DSSDocument in eu.europa.esig.dss.asic.xades

Uses of DSSDocument in eu.europa.esig.dss.asic.xades.merge

Uses of DSSDocument in eu.europa.esig.dss.asic.xades.signature

Uses of DSSDocument in eu.europa.esig.dss.asic.xades.signature.asice

Uses of DSSDocument in eu.europa.esig.dss.asic.xades.signature.asics

Uses of DSSDocument in eu.europa.esig.dss.asic.xades.validation

Uses of DSSDocument in eu.europa.esig.dss.cades

Uses of DSSDocument in eu.europa.esig.dss.cades.signature

Uses of DSSDocument in eu.europa.esig.dss.cades.validation

Uses of DSSDocument in eu.europa.esig.dss.cades.validation.scope

Uses of DSSDocument in eu.europa.esig.dss.jades

Uses of DSSDocument in eu.europa.esig.dss.jades.signature

Uses of DSSDocument in eu.europa.esig.dss.jades.validation

Uses of DSSDocument in eu.europa.esig.dss.jades.validation.scope

Uses of DSSDocument in eu.europa.esig.dss.model

Uses of DSSDocument in eu.europa.esig.dss.pades

Uses of DSSDocument in eu.europa.esig.dss.pades.signature

Uses of DSSDocument in eu.europa.esig.dss.pades.timestamp

Uses of DSSDocument in eu.europa.esig.dss.pades.validation

Uses of DSSDocument in eu.europa.esig.dss.pdf

Uses of DSSDocument in eu.europa.esig.dss.pdf.openpdf

Uses of DSSDocument in eu.europa.esig.dss.pdf.pdfbox

Uses of DSSDocument in eu.europa.esig.dss.pdf.pdfbox.visible.defaultdrawer

Uses of DSSDocument in eu.europa.esig.dss.pdf.visible

Uses of DSSDocument in eu.europa.esig.dss.pdfa

Uses of DSSDocument in eu.europa.esig.dss.pdfa.validation

Uses of DSSDocument in eu.europa.esig.dss.service.http.commons

Uses of DSSDocument in eu.europa.esig.dss.signature

Uses of DSSDocument in eu.europa.esig.dss.signature.resources

Uses of DSSDocument in eu.europa.esig.dss.spi

Uses of DSSDocument in eu.europa.esig.dss.spi.client.http

Uses of DSSDocument in eu.europa.esig.dss.spi.x509.revocation.crl

Uses of DSSDocument in eu.europa.esig.dss.spi.x509.revocation.ocsp

Uses of DSSDocument in eu.europa.esig.dss.tsl.download

Uses of DSSDocument in eu.europa.esig.dss.tsl.parsing

Uses of DSSDocument in eu.europa.esig.dss.tsl.runnable

Uses of DSSDocument in eu.europa.esig.dss.tsl.validation

Uses of DSSDocument in eu.europa.esig.dss.validation

Uses of DSSDocument in eu.europa.esig.dss.validation.policy

Uses of DSSDocument in eu.europa.esig.dss.validation.scope

Uses of DSSDocument in eu.europa.esig.dss.validation.timestamp

Uses of DSSDocument in eu.europa.esig.dss.ws.converter

Uses of DSSDocument in eu.europa.esig.dss.xades

Uses of DSSDocument in eu.europa.esig.dss.xades.reference

Uses of DSSDocument in eu.europa.esig.dss.xades.signature

Uses of DSSDocument in eu.europa.esig.dss.xades.validation

Uses of DSSDocument in eu.europa.esig.dss.xades.validation.policy

Uses of Interface
eu.europa.esig.dss.model.DSSDocument